リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET, POST	/getCloudPostgresqlUserList

リクエストヘッダ

Cloud DB for PostgreSQL (VPC) APIで共通して使用されるヘッダの詳細は、Cloud DB for PostgreSQL (VPC)のリクエストヘッダをご参照ください。

リクエストパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード照会対象の Cloud DB for PostgreSQLインスタンスのリージョンコード getRegionListを通じて確認 `getRegionList`照会結果の最初のリージョン(デフォルト)
`cloudPostgresqlInstanceNo`	String	Required	Cloud DB for PostgreSQLインスタンス番号 getCloudPostgresqlInstanceListを通じて確認
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vpostgresql/v2/getCloudPostgresqlUserList
?regionCode=KR
&cloudPostgresqlInstanceNo=****925'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの詳細は、CloudPostgresqlUserListをご参照ください。

レスポンスステータスコード

NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

responseFormatType=jsonの場合

{
    "getCloudPostgresqlUserListResponse": {
        "totalRows": 1,
        "cloudPostgresqlUserList": [
            {
                "userName": "testuser",
                "clientCidr": "0.0.0.0/0",
                "isReplicationRole": false
            }
        ],
        "requestId": "d6cd4b3f-****-****-****-f673240188ba",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

responseFormatType=xml(デフォルト)の場合

<?xml version="1.0" encoding="UTF-8"?>
<getCloudPostgresqlUserListResponse>
    <requestId>d6cd4b3f-****-****-****-f673240188ba</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>

この記事は役に立ちましたか?

リクエスト
レスポンス

タグ

Cloud DB for PostgreSQL