getCloudCacheBucketList

VPC環境で利用できます。

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

参考

Cloud DB for Cache APIは、対応する DBMSの範囲に応じて2つのバージョンを提供しています。

getCloudCacheBucketList API: Valkey、Redis DBMSを利用可能
getCloudRedisBucketList API: Redis DBMSを利用可能

getCloudCacheBucketList API

getCloudCacheBucketList APIのリクエストおよびレスポンス形式を説明します。

リクエスト

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

メソッド	URI
GET \| POST	/getCloudCacheBucketList

参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

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

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

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

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

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

Cloud DB for Cache (VPC) APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud DB for Cache (VPC)のレスポンスステータスコードをご参照ください。

レスポンス例

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

responseFormatType=jsonの場合

{
  "getCloudCacheBucketListResponse": {
    "requestId": "40cb968e-72ef-42d3-adc3-e392e8f7cc99",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 2,
    "cloudCacheBucketList": [
      {
        "bucketName": "aab***"
      },
      {
        "bucketName": "asdsd****"
      }
    ]
  }
}

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


<getCloudCacheBucketListResponse>
    <requestId>9f2c90d3-9f6d-4891-af62-780c36949402</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>2</totalRows>
    <cloudCacheBucketList>
        <cloudCacheBucket>
            <bucketName>aab***</bucketName>
        </cloudCacheBucket>
        <cloudCacheBucket>
            <bucketName>asdsd****</bucketName>
        </cloudCacheBucket>
    </cloudCacheBucketList>
</getCloudCacheBucketListResponse>

getCloudRedisBucketList API

getCloudRedisBucketList APIのリクエストおよびレスポンス形式を説明します。