Documentation Index

Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

getCloudCacheManualBackupList

Prev Next

VPC環境で利用できます。

Cloud DB for Cache Manual Backupリストを照会します。

参考

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

  • getCloudCacheManualBackupList API: Valkey、Redis DBMSを利用可能
  • getCloudRedisManualBackupList API: Redis DBMSを利用可能

getCloudCacheManualBackupList API

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

リクエスト

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

メソッド URI
GET | POST /getCloudCacheManualBackupList
参考

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional 照会対象 Manual Backupリストのリージョンコード
  • getRegionListを参照
  • getRegionList照会結果の最初のリージョン(デフォルト)
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vcache/v2/getCloudCacheManualBackupList
?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=jsonの場合

    {
  "getCloudCacheManualBackupListResponse": {
    "requestId": "7add8ece-0259-467d-bdc7-de214f51c93d",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 1,
    "cloudCacheBackupList": [
      {
        "cloudCacheInstanceNo": "2360***",
        "cloudCacheServiceName": "cxcs***",
        "backupTime": "14:10",
        "backupSize": 906,
        "lastBackupDate": "2022-05-18T00:00:00+0900",
        "backupType": {
          "code": "CLUSTER",
          "codeName": "CLOUD CACHE(VPC) Cluster Backup Type"
        },
        "shardCount": 3
      }
    ]
  }
}

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

    
<getCloudCacheManualBackupListResponse>
    <requestId>428ce123-d4cf-4805-8810-f243d5c6f65f</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudCacheBackupList>
        <cloudCacheBackup>
            <cloudCacheInstanceNo>2360***</cloudCacheInstanceNo>
            <cloudCacheServiceName>cxcs***</cloudCacheServiceName>
            <backupTime>16:25</backupTime>
            <backupSize>302</backupSize>
            <lastBackupDate>2022-05-16T00:00:00+0900</lastBackupDate>
            <backupType>
                <code>CLUSTER</code>
                <codeName>CLOUD CACHE(VPC) Cluster Backup Type</codeName>
            </backupType>
            <shardCount>3</shardCount>
        </cloudCacheBackup>
    </cloudCacheBackupList>
</getCloudCacheManualBackupListResponse>

getCloudRedisManualBackupList API

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

リクエスト

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

メソッド URI
GET | POST /vredis/v2/getCloudRedisManualBackupList
参考

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional 照会対象 Manual Backupリストのリージョンコード
  • getRegionListを参照
  • getRegionList照会結果の最初のリージョン(デフォルト)
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vredis/v2/getCloudRedisManualBackupList
?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}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

  • responseFormatType=jsonの場合

    {
    "getCloudRedisManualBackupListResponse": {
        "totalRows": 1,
        "cloudRedisBackupList": [
            {
                "cloudRedisInstanceNo": "****511",
                "cloudRedisServiceName": "test-****",
                "backupTime": "11:58",
                "backupSize": 525,
                "lastBackupDate": "2024-07-02T00:00:00+0900",
                "backupType": {
                    "code": "CLUSTER",
                    "codeName": "CLOUD REDIS(VPC) Cluster Backup Type"
                },
                "shardCount": 3
            }
        ],
        "requestId": "2be6d7ae-****-****-****-26487a0c19af",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

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

    <?xml version="1.0" encoding="UTF-8"?>
<getCloudRedisManualBackupListResponse>
    <requestId>2be6d7ae-****-****-****-26487a0c19af</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudRedisBackupList>
        <cloudRedisBackup>
            <cloudRedisInstanceNo>****511</cloudRedisInstanceNo>
            <cloudRedisServiceName>test-****</cloudRedisServiceName>
            <backupTime>11:58</backupTime>
            <backupSize>525</backupSize>
            <lastBackupDate>2024-07-02T00:00:00+0900</lastBackupDate>
            <backupType>
                <code>CLUSTER</code>
                <codeName>CLOUD REDIS(VPC) Cluster Backup Type</codeName>
            </backupType>
            <shardCount>3</shardCount>
        </cloudRedisBackup>
    </cloudRedisBackupList>
</getCloudRedisManualBackupListResponse>
事業者登録番号: 129-86-31394 通信販売業申告番号:第2009-京畿城南-0510号
代表取締役: キム・ユウォン アドレス: 13561 京畿道 城南市 盆唐区 仏亭路6 グリーンファクトリー, 17~26F お客様センターの代表電話: 1544-5876
© NAVER Cloud Corp. All Rights Reserved.