getCloudPostgresqlBucketList

Prev Next

VPC環境で利用できます。

Cloud DB for PostgreSQLで使用可能な Object Storageバケットリストを照会します。

リクエスト

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

メソッド URI
GET, POST /getCloudPostgresqlBucketList

リクエストヘッダ

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

リクエストパラメータ

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • 照会対象の Cloud DB for PostgreSQLインスタンスのリージョンコード
  • getRegionListを通じて確認
  • getRegionList照会結果の最初のリージョン(デフォルト)
cloudPostgresqlServerInstanceNo String Optional Cloud DB for PostgreSQLサーバインスタンス番号
  • getCloudPostgresqlInstanceListを通じて確認
  • 入力時、そのインスタンスでアクセス可能な Object Storageバケットリストを照会
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

  • responseFormatType=jsonの場合
{
    "getCloudPostgresqlBucketListResponse": {
        "totalRows": 2,
        "cloudPostgresqlBucketList": [
            {
                "bucketName": "bucket***"
            },
            {
                "bucketName": "bucket***"
            }
        ],
        "requestId": "7b000498-****-****-****-b357e6916bc8",
        "returnCode": "0",
        "returnMessage": "success"
    }
}
  • responseFormatType=xml(デフォルト)の場合
<?xml version="1.0" encoding="UTF-8"?>
<getCloudPostgresqlBucketListResponse>
    <requestId>7b000498-****-****-****-b357e6916bc8</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>2</totalRows>
    <cloudPostgresqlBucketList>
        <cloudPostgresqlBucket>
            <bucketName>bucket***</bucketName>
        </cloudPostgresqlBucket>
        <cloudPostgresqlBucket>
            <bucketName>bucket***</bucketName>
        </cloudPostgresqlBucket>
    </cloudPostgresqlBucketList>
</getCloudPostgresqlBucketListResponse>