getCloudCacheManualBackupDetailList

VPC環境で利用できます。

使用可能な Cloud DB for Cache Manual Backupの詳細情報リストを照会します。

参考

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

getCloudCacheManualBackupDetailList API: Valkey、Redis DBMSを利用可能
getCloudRedisManualBackupDetailList API: Redis DBMSを利用可能

getCloudCacheManualBackupDetailList API

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

リクエスト

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

メソッド	URI
GET \| POST	/getCloudCacheManualBackupDetailList

参考

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	詳細情報リスト照会対象の Manual Backupのリージョンコード 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/getCloudCacheManualBackupDetailList
?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}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

responseFormatType=jsonの場合

{
  "getCloudCacheManualBackupDetailListResponse": {
    "requestId": "e603a8ee-9308-457e-9754-5497c931f222",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 1,
    "cloudCacheBackupDetailList": [
      {
        "startTime": "2022-05-18T14:10:28+0900",
        "endTime": "2022-05-18T14:10:28+0900",
        "backupSize": 302,
        "dataStorageSize": 10737418240,
        "fileName": "2022051*****"
      }
    ]
  }
}

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


<getCloudCacheManualBackupDetailListResponse>
    <requestId>213c6297-42ab-4ac4-81fd-9852837c3105</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudCacheBackupDetailList>
        <cloudCacheBackupDetail>
            <startTime>2022-05-16T16:25:07+0900</startTime>
            <endTime>2022-05-16T16:25:07+0900</endTime>
            <backupSize>302</backupSize>
            <dataStorageSize>10737418240</dataStorageSize>
            <fileName>2022051*****</fileName>
        </cloudCacheBackupDetail>
    </cloudCacheBackupDetailList>
</getCloudCacheManualBackupDetailListResponse>

getCloudRedisManualBackupDetailList API

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