List database instances

データベース仮想サーバを一覧表示します。

APIエンドポイント

リージョン	APIエンドポイント
西日本リージョン3の場合	https://database.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合	https://database.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI

GET

/v1.0/{accountId}/instances

HTTPステータスコード

正常時：200

エラー時：400,401,403,404,405,413,422,500,501,503

リクエストパラメータの説明

名前	In	Type	デフォルト値 /必須指定	Description
accountId	path	string	必須	データベース仮想サーバのアカウントID

レスポンスボディ（正常系）の説明

名前	Type	Description
instances	array	データベース仮想サーバのオブジェクト
status	string	データベース仮想サーバのステータス
name	string	データベース仮想サーバ名
links	array	データベース仮想サーバへのリンク情報
links.href	string	データベース仮想サーバへのリンクのhref属性
links.rel	string	データベース仮想サーバへのリンクのrel属性
region	string	データベース仮想サーバのリージョン名
id	string	データベース仮想サーバのID
volume	object	ボリュームオブジェクト
volume.size	integer	ボリュームのサイズ(GB単位) 指定可能な範囲は、1～50です。
flavor	object	フレーバーのオブジェクトで、フレーバーID (integer)とフレーバー関連のリンクURLが含まれています。
flavor.id	string	フレーバーのID
flavor.links	array	フレーバーへのリンク情報
flavor.links.href	string	フレーバーへのリンクのhref情報
flavor.links.rel	string	フレーバーへのリンクのrel情報
datastore	object	データストアオブジェクト
datastore.type	string	データストアのタイプ
datastore.version	string	データストアのバージョン名またはID

レスポンス例

{
  "instances": [
    {
      "status": "ACTIVE",
      "name": "instance01",
      "links": [
        {
          "href": "https://10.25.177.171:8779/v1.0/2a53d9a627a546ab8da2a29863c9a81c/instances/7143b491-2ce5-40e9-986d-71f9cebeb2e9",
          "rel": "self"
        },
        {
          "href": "https://10.25.177.171:8779/instances/7143b491-2ce5-40e9-986d-71f9cebeb2e9",
          "rel": "bookmark"
        }
      ],
      "region": "KT120_Z8",
      "id": "7143b491-2ce5-40e9-986d-71f9cebeb2e9",
      "volume": {
        "size": 2
      },
      "flavor": {
        "id": "ce448e97-6b84-4ccb-bcd6-618cea3248fd",
        "links": [
          {
            "href": "https://10.25.177.171:8779/v1.0/2a53d9a627a546ab8da2a29863c9a81c/flavors/ce448e97-6b84-4ccb-bcd6-618cea3248fd",
            "rel": "self"
          },
          {
            "href": "https://10.25.177.171:8779/flavors/ce448e97-6b84-4ccb-bcd6-618cea3248fd",
            "rel": "bookmark"
          }
        ]
      },
      "datastore": {
        "version": "9.6",
        "type": "postgresql"
      }
    }
  ]
}