VPC環境で利用できます。
使用可能な Cloud DB for Cache System Backupの詳細情報リストを照会します。
Cloud DB for Cache APIは、対応する DBMSの範囲に応じて2つのバージョンを提供しています。
- getCloudCacheBackupDetailList API: Valkey、Redis DBMSを利用可能
- getCloudRedisBackupDetailList API: Redis DBMSを利用可能
getCloudCacheBackupDetailList API
getCloudCacheBackupDetailList APIのリクエストおよびレスポンス形式を説明します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | POST | /getCloudCacheBackupDetailList |
ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。
リクエストヘッダ
Cloud DB for Cache APIで共通して使用されるヘッダの詳細は、Cloud DB for Cacheのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
regionCode |
String | Optional | 照会対象の System Backup詳細情報リストのリージョンコード
|
cloudCacheInstanceNo |
String | Required | Cloud DB for Cacheインスタンス番号 |
responseFormatType |
String | Optional | レスポンス結果の形式
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vcache/v2/getCloudCacheBackupDetailList
?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=xml(デフォルト)の場合<getCloudCacheBackupDetailListResponse> ```xmlequestId>2e320a76-469e-4f28-81b0-a03ea6c8053b</requestId> <returnCode>0</returnCode> <getCloudCacheBackupDetailListResponse>ge> <requestId>2e320a76-469e-4f28-81b0-a03ea6c8053b</requestId> <returnCode>0</returnCode>t> <returnMessage>success</returnMessage> <totalRows>1</totalRows>05-12T16:00:00+0900</startTime> <cloudCacheBackupDetailList>16:00:00+0900</endTime> <cloudCacheBackupDetail>kupSize> <startTime>2021-05-12T16:00:00+0900</startTime> <endTime>2021-05-12T16:00:00+0900</endTime> <backupSize>116</backupSize> <dataStorageSize>10737418240</dataStorageSize> </cloudCacheBackupDetail> </cloudCacheBackupDetailList> </getCloudCacheBackupDetailListResponse>ame="getCloudCacheBackupDetailList API"></a>
getCloudRedisBackupDetailList API
getCloudRedisBackupDetailList APIのリクエストおよびレスポンス形式を説明します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | POST | /vredis/v2/getCloudRedisBackupDetailList |
ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。
リクエストヘッダ
Cloud DB for Cache APIで共通して使用されるヘッダの詳細は、Cloud DB for Cacheのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
regionCode |
String | Optional | 照会対象の System Backup詳細情報リストのリージョンコード
|
cloudRedisInstanceNo |
String | Required | Cloud DB for Cacheインスタンス番号 |
responseFormatType |
String | Optional | レスポンス結果の形式
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vredis/v2/getCloudRedisBackupDetailList
?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}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの詳細は、CloudRedisBackupDetailListをご参照ください。
レスポンスステータスコード
Cloud DB for Cache (VPC) APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud DB for Cache (VPC)のレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
-
responseFormatType=jsonの場合{ "getCloudRedisBackupDetailListResponse": { "totalRows": 1, "cloudRedisBackupDetailList": [ { "startTime": "2024-07-02T06:15:02+0900", "endTime": "2024-07-02T06:15:02+0900", "backupSize": 525, "dataStorageSize": 10737418240, "fileName": "20240702" } ], "requestId": "7fff7545-****-****-****-7ee52b044aa3", "returnCode": "0", "returnMessage": "success" } } -
responseFormatType=xml(デフォルト)の場合<?xml version="1.0" encoding="UTF-8"?> <getCloudRedisBackupDetailListResponse> <requestId>7fff7545-****-****-****-7ee52b044aa3</requestId> <returnCode>0</returnCode> <returnMessage>success</returnMessage> <totalRows>1</totalRows> <cloudRedisBackupDetailList> <cloudRedisBackupDetail> <startTime>2024-07-02T06:15:02+0900</startTime> <endTime>2024-07-02T06:15:02+0900</endTime> <backupSize>525</backupSize> <dataStorageSize>10737418240</dataStorageSize> <fileName>20240702</fileName> </cloudRedisBackupDetail> </cloudRedisBackupDetailList> </getCloudRedisBackupDetailListResponse>