getCloudPostgresqlDatabaseList

VPC環境で利用できます。

Cloud DB for PostgreSQLインスタンスの Databaseリストを照会します。

リクエスト

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

リクエストヘッダ

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

リクエストパラメータ

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

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vpostgresql/v2/getCloudPostgresqlDatabaseList
?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}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

• responseFormatType=jsonの場合

{
    "getCloudPostgresqlDatabaseListResponse": {
        "totalRows": 1,
        "cloudPostgresqlDatabaseList": [
            {
                "databaseName": "pgtest",
                "owner": "testuser"
            }
        ],
        "requestId": "f29bb0b6-****-****-****-6473169378b4",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

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

<?xml version="1.0" encoding="UTF-8"?>
<getCloudPostgresqlDatabaseListResponse>
    <requestId>f29bb0b6-****-****-****-6473169378b4</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudPostgresqlDatabaseList>
        <cloudPostgresqlDatabase>
            <databaseName>pgtest</databaseName>
            <owner>testuser</owner>
        </cloudPostgresqlDatabase>
    </cloudPostgresqlDatabaseList>
</getCloudPostgresqlDatabaseListResponse>