getCloudCacheBackupList

VPC環境で利用できます。

Cloud DB for Cacheシステムバックアップリストを照会します。

参考

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

getCloudCacheBackupList API: Valkey、Redis DBMSを利用可能
getCloudRedisBackupList API: Redis DBMSを利用可能

getCloudCacheBackupList API

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

リクエスト

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

メソッド	URI
GET \| POST	/getCloudCacheBackupList

参考

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

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


<getCloudCacheBackupListResponse>
    <requestId>94edea29-9c1e-44f5-9e9c-120f22688ca1</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudCacheBackupList>
        <cloudCacheBackup>
            <cloudCacheInstanceNo>****890</cloudCacheInstanceNo>
            <cloudCacheServiceName>test-****</cloudCacheServiceName>
            <backupFileRetentionPeriod>1</backupFileRetentionPeriod>
            <backupTime>00:30</backupTime>
            <backupSize>302</backupSize>
            <lastBackupDate>2021-05-25T00:00:00+0900</lastBackupDate>
            <backupType>
                <code>SIMPLE</code>
                <codeName>CLOUD CACHE(VPC) Cluster Backup Type</codeName>
            </backupType>
            <shardCount>1</shardCount>
        </cloudCacheBackup>
    </cloudCacheBackupList>
</getCloudCacheBackupListResponse>

getCloudRedisBackupList API

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