getCloudPostgresqlUserList

Prev Next

VPC環境で利用できます。

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

コマンド

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

ncloud vpostgresql getCloudPostgresqlUserList [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		 -

レスポンス

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

  • CloudPostgresqlUserListタイプ
CloudPostgresqlUserList extends CommonResponse 説明
private Integer totalRows; 照会されたリストの総数
private List<CloudPostgresqlUser> cloudPostgresqlUserList = new ArrayList<>(); Cloud DB for PostgreSQL DB Userリスト
  • CloudPostgresqlUserタイプ
CloudPostgresqlUser 説明
private String userName; DB User ID
private String clientCidr; Client CIDR
private Boolean isReplicationRole; Replication Roleの有無

例

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

呼び出し例

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

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

レスポンス例

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

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

{
  "getCloudPostgresqlUserListResponse": {
    "requestId": "d733e677-ad69-4cbe-8351-711d0e0124bc",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "cloudPostgresqlUserList": [
      {
        "userName": "testuser",
        "clientCidr": "0.0.0.0/0",
        "isReplicationRole": false
      }
    ]
  }
}

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

<getCloudPostgresqlUserListResponse>
  <requestId>d733e677-ad69-4cbe-8351-711d0e0124bc</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <cloudPostgresqlUserList>
    <cloudPostgresqlUser>
      <userName>testuser</userName>
      <clientCidr>0.0.0.0/0</clientCidr>
      <isReplicationRole>false</isReplicationRole>
    </cloudPostgresqlUser>
  </cloudPostgresqlUserList>
</getCloudPostgresqlUserListResponse>