Create database instance#
データベース仮想サーバを作成します。
APIエンドポイント#
リージョン | APIエンドポイント |
---|---|
西日本リージョン3の場合 | https://database.jp-west-3.cloud.global.fujitsu.com |
東日本リージョン3の場合 | https://database.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI#
POST
/v1.0/{accountId}/instances
HTTPステータスコード#
正常時:200
エラー時:400,401,403,404,405,413,422,500,501,503
リクエストパラメータの説明#
名前 | In | Type | デフォルト値 /必須指定 |
Description |
---|---|---|---|---|
accountId | path | string | 必須 | データベース仮想サーバのアカウントID |
instance | body | object | 必須 | データベース仮想サーバのオブジェクト |
datastore | body | object | 必須 | データストアオブジェクト |
datastore.type | body | string | 必須 | データストアのタイプ 「postgresql」だけが指定可能です。 |
datastore.version | body | string | 必須 | データベース仮想サーバ作成時に使うデータストアバージョン名 「9.6」だけが指定可能です。 |
name | body | string | 必須 | データベース仮想サーバの名前 |
nics | body | array | 必須 | ネットワークインターフェースの情報 📒注: nicsオプションで指定できるnicは1つだけです。複数指定した場合、初めに指定した1つだけがアタッチされ、2つ目以降は無視されます。 |
nics.net-id | body | string | 必須 | NICのUUID |
nics.v4-fixed-ip | body | string | 任意 | NICの固定IPアドレス |
flavorRef | body | string | 必須 | フレーバーのURI フレーバーのURIの代わりに、フレーバーIDを指定することも可能です。 |
volume | body | object | 任意 | ボリュームオブジェクト |
volume.size | body | integer | 必須 | ボリュームのサイズ(GB単位) 指定可能な範囲は、1~50です。 |
volume.type | body | string | 任意 | 利用するボリュームタイプ ボリュームタイプを設定する場合、ボリュームサイズも指定する必要があります。 |
databases | body | array | 任意 | データベースオブジェクトの一覧 |
databases.name | body | string | 必須 | データベース名 |
configuration | body | string | 任意 | データベース仮想サーバにアタッチするデータベース設定グループのID |
users | body | array | 任意 | ユーザーオブジェクトの一覧 |
users.name | body | string | 必須 | ユーザー名 |
users.password | body | string | 必須 | ユーザーパスワード |
users.databases | body | array | 必須 | ユーザーがアクセスできるデータベースオブジェクトのリスト |
users.databases.name | body | string | 必須 | ユーザーがアクセスできるデータベース名 |
レスポンスボディ(正常系)の説明#
名前 | Type | Description |
---|---|---|
instance | object | データベース仮想サーバのオブジェクト |
status | string | データベース仮想サーバのステータス |
updated | string | リソースの最新更新日時 日時の入力形式は以下のISO 8601形式です。 CCYY-MM-DDThh:mm:ss±hh:mm 「±hh:mm」の部分は、UTCからのオフセットで表示されるタイムゾーンです。表示されない場合もあります。 例えば、以下の出力例に、UTCのタイムゾーンが想定されます。 2015-08-27T09:49:58-05:00 |
name | string | データベース仮想サーバ名 |
links | array | データベース仮想サーバへのリンク情報 |
links.href | string | データベース仮想サーバへのリンクのhref属性 |
links.rel | string | データベース仮想サーバへのリンクのrel属性 |
created | string | リソースの作成日時 日時の入力形式は以下のISO 8601形式です。 CCYY-MM-DDThh:mm:ss±hh:mm 例:2015-08-27T09:49:58-05:00 「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合にだけ表示されます。上記の例に、オフセットの値は「-05:00」です。 |
ip | string | データベース仮想サーバのIPアドレス |
tenant_id | string | プロジェクトID |
region | string | データベース仮想サーバのリージョン名 |
server_id | string | データベース仮想サーバのID |
id | string | データベース仮想サーバのID |
volume | object | ボリュームオブジェクト |
volume.size | integer | ボリュームのサイズ |
volume.used | float | ボリュームの使用領域(GB単位) |
volume_id | string | ボリュームのID |
flavor | object | フレーバーのオブジェクトで、フレーバーID (integer)とフレーバー関連のリンクURLが含まれています。 |
flavor.id | string | フレーバーのID |
flavor.links | array | フレーバーへのリンク情報 |
flavor.links.href | string | フレーバーへのリンクのhref属性 |
flavor.links.rel | string | フレーバーへのリンクのrel属性 |
configuration | object | データベース設定オブジェクト |
configuration.id | string | データベース設定オブジェクトのID |
configuration.name | string | データベース設定オブジェクト名 |
configuration.links | array | データベース設定オブジェクトへのリンク情報 |
configuration.links.href | string | データベース設定オブジェクトへのリンクのhref属性 |
configuration.links.rel | string | データベース設定オブジェクトへのリンクのrel属性 |
datastore | object | データストアオブジェクト |
datastore.type | string | データストアのタイプ |
datastore.version | string | データストアのバージョン名またはID |
encrypted_rpc_messaging | boolean | データベース仮想サーバが、通信のRPM暗号化を利用しているかどうかを表示します。 |
metadata | object | メタデータオブジェクト |
metadata.fcx.autofailover | string | オートフェイルオーバ機能を使用しているかどうかを表示します。 |
リクエスト例#
{ "instance": { "name": "instance01", "nics": [ { "net-id": "46b6b3cf-0498-49c5-bc7f-70562e870d56" } ], "flavorRef": "01f82564-a762-4784-8bff-be2a70dd8786", "volume": { "size": 2 }, "databases": [ { "name": "sampledb" }, { "name": "nextround" } ], "datastore": { "version": "9.6", "type": "postgresql" }, "configuration": "0d190166-1d4a-4ba0-98d0-0bfd74499b1f", "users": [ { "password": "demopassword", "name": "demouser", "databases": [ { "name": "sampledb" } ] } ] } }
レスポンス例#
{ "instance": { "status": "BUILD", "updated": "2018-07-20T01:57:22", "name": "instance01", "links": [ { "href": "https://openstack.management.g2pstg-2.local:8779/v1.0/6d03c527542741768c7c89f1ea373e27/instances/1f546be5-70a3-466e-bdf2-4ff5f5ee6f9e", "rel": "self" }, { "href": "https://openstack.management.g2pstg-2.local:8779/instances/1f546be5-70a3-466e-bdf2-4ff5f5ee6f9e", "rel": "bookmark" } ], "created": "2018-07-20T01:57:22", "region": "g2pstg-2", "id": "1f546be5-70a3-466e-bdf2-4ff5f5ee6f9e", "volume": { "size": 2 }, "flavor": { "id": "01f82564-a762-4784-8bff-be2a70dd8786", "links": [ { "href": "https://openstack.management.g2pstg-2.local:8779/v1.0/6d03c527542741768c7c89f1ea373e27/flavors/01f82564-a762-4784-8bff-be2a70dd8786", "rel": "self" }, { "href": "https://openstack.management.g2pstg-2.local:8779/flavors/01f82564-a762-4784-8bff-be2a70dd8786", "rel": "bookmark" } ] }, "configuration": { "id": "0d190166-1d4a-4ba0-98d0-0bfd74499b1f", "links": [ { "href": "https://openstack.management.g2pstg-2.local:8779/v1.0/6d03c527542741768c7c89f1ea373e27/configurations/0d190166-1d4a-4ba0-98d0-0bfd74499b1f", "rel": "self" }, { "href": "https://openstack.management.g2pstg-2.local:8779/configurations/0d190166-1d4a-4ba0-98d0-0bfd74499b1f", "rel": "bookmark" } ], "name": "tempest-DatabaseInstancesCreateTest-test-config-1825643381" }, "datastore": { "version": "9.6", "type": "postgresql" }, "metadata": \{ "fcx.autofailover": "true" } } }