getCloudCacheBucketList

Prev Next

VPC環境で利用できます。

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

リクエスト

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

メソッド URI
GET, POST /getCloudRedisBucketList

リクエストヘッダ

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

リクエストパラメータ

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

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

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

  • responseFormatType=jsonの場合

    {
        "getCloudRedisBucketListResponse": {
            "totalRows": 1,
            "cloudRedisBucketList": [
                {
                    "bucketName": "redis-backup"
                }
            ],
            "requestId": "77234b5b-****-****-****-507e0f8839a7",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
  • responseFormatType=xml(デフォルト)の場合

    <?xml version="1.0" encoding="UTF-8"?>
    <getCloudRedisBucketListResponse>
        <requestId>77234b5b-****-****-****-507e0f8839a7</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <cloudRedisBucketList>
            <cloudRedisBucket>
                <bucketName>redis-backup</bucketName>
            </cloudRedisBucket>
        </cloudRedisBucketList>
    </getCloudRedisBucketListResponse>