getCloudPostgresqlDatabaseList

Prev Next

VPC環境で利用できます。

Cloud DB for PostgreSQL Databaseリストを照会します。

コマンド

コマンド構文は、次のとおりです。

ncloud vpostgresql getCloudPostgresqlDatabaseList [regionCode] [cloudPostgresqlInstanceNo] [output]

パラメータ

パラメータについての説明は、次のとおりです。

パラメータ タイプ 要否 説明 制約事項
regionCode String N リージョンコード
- regionCodeは、getRegionListアクションを通じて取得
- default: getRegionList照会結果の最初のリージョンを選択		 -
cloudPostgresqlInstanceNo String Y Cloud DB for PostgreSQLのインスタンス番号
- cloudPostgresqlInstanceNoは、getCloudPostgresqlInstanceListアクションを通じて取得		 -
output String N レスポンス結果のフォーマットタイプ
- options: xml | json
- default: json		 -

レスポンス

レスポンスデータのタイプ

  • CloudPostgresqlDatabaseListタイプ
CloudPostgresqlDatabaseList extends CommonResponse 説明
private Integer totalRows; 照会されたリストの総数
private List<CloudPostgresqlDatabase> cloudPostgresqlDatabaseList = new ArrayList<>(); Cloud DB for PostgreSQL Databaseリスト
  • CloudPostgresqlDatabaseタイプ
CloudPostgresqlDatabase 説明
private String databaseName; Database名
private String owner; Database所有者 User ID

例

呼び出しとレスポンス例を説明します。

呼び出し例

呼び出し例は、次のとおりです。

ncloud vpostgresql getCloudPostgresqlDatabaseList --regionCode KR --cloudPostgresqlInstanceNo ****890

レスポンス例

レスポンス例は、次のとおりです。

レスポンス結果フォーマットタイプ(output)が jsonのとき

{
  "getCloudPostgresqlDatabaseListResponse": {
    "requestId": "32993542-96c8-4899-91d8-3a273960b79c",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "cloudPostgresqlDatabaseList": [
      {
        "databaseName": "pgtest",
        "owner": "testuser"
      }
    ]
  }
}

レスポンス結果フォーマットタイプ(output)が xmlの場合

<getCloudPostgresqlDatabaseListResponse>
  <requestId>32993542-96c8-4899-91d8-3a273960b79c</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <cloudPostgresqlDatabaseList>
    <cloudPostgresqlDatabase>
      <databaseName>pgtest</databaseName>
      <owner>testuser</owner>
    </cloudPostgresqlDatabase>
  </cloudPostgresqlDatabaseList>
</getCloudPostgresqlDatabaseListResponse>