getCloudCacheManualBackupDetailList

Prev Next

VPC環境で利用できます。

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

リクエスト

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

メソッド URI
GET, POST /getCloudRedisManualBackupDetailList

リクエストヘッダ

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

リクエストパラメータ

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

フィールド タイプ 必須の有無 説明
regionCode String Optional 詳細情報リスト照会対象の Manual Backupのリージョンコード
  • 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/getCloudRedisManualBackupDetailList
?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をご参照ください。

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

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

レスポンス例

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

  • responseFormatType=jsonの場合

    {
        "getCloudRedisManualBackupDetailListResponse": {
            "totalRows": 1,
            "cloudRedisBackupDetailList": [
                {
                    "startTime": "2024-07-02T11:58:45+0900",
                    "endTime": "2024-07-02T11:58:45+0900",
                    "backupSize": 525,
                    "dataStorageSize": 10737418240,
                    "fileName": "2024070*****"
                }
            ],
            "requestId": "6c89411a-****-****-****-198ff84f5f1c",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
  • responseFormatType=xml(デフォルト)の場合

    <?xml version="1.0" encoding="UTF-8"?>
    <getCloudRedisManualBackupDetailListResponse>
        <requestId>6c89411a-****-****-****-198ff84f5f1c</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <cloudRedisBackupDetailList>
            <cloudRedisBackupDetail>
                <startTime>2024-07-02T11:58:45+0900</startTime>
                <endTime>2024-07-02T11:58:45+0900</endTime>
                <backupSize>525</backupSize>
                <dataStorageSize>10737418240</dataStorageSize>
                <fileName>2024070*****</fileName>
            </cloudRedisBackupDetail>
        </cloudRedisBackupDetailList>
    </getCloudRedisManualBackupDetailListResponse>