createCloudCacheManualBackup

Prev Next

VPC環境で利用できます。

Cloud DB for Cache Manual Backupを作成します。

参考

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

  • createCloudCacheManualBackup API: Valkey、Redis DBMSを利用可能
  • createCloudRedisManualBackup API: Redis DBMSを利用可能

createCloudCacheManualBackup API

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

リクエスト

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

メソッド URI
GET | POST /vcache/v2/createCloudCacheManualBackup
参考

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional Manual Backupを作成する Cloud DB for Cacheインスタンスのリージョンコード
  • getRegionListを参照
  • getRegionList照会結果の最初のリージョン(デフォルト)
cloudCacheInstanceNo String Required Cloud DB for Cacheインスタンス番号
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

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

レスポンス

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

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

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

レスポンス例

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

  • responseFormatType=jsonの場合

    {
      "createCloudCacheManualBackupResponse": {
        "requestId": "e5a2ba21-beea-4ab5-a5d0-7c8f056a925c",
        "returnCode": "0",
        "returnMessage": "success"
      }
    }
    
  • responseFormatType=xml(デフォルト)の場合

    
    <createCloudCacheManualBackupResponse>
        <requestId>f293fb65-bdd3-4633-bda2-8d84cd8d7271</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
    </createCloudCacheManualBackupResponse>
    

createCloudRedisManualBackup API

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

リクエスト

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

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • 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/createCloudRedisManualBackup
?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}'

レスポンス

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

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

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

レスポンス例

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

  • responseFormatType=jsonの場合

    {
        "createCloudRedisManualBackupResponse": {
            "requestId": "6fa60f37-****-****-****-b98ed187c0fd",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
  • responseFormatType=xml(デフォルト)の場合

    <?xml version="1.0" encoding="UTF-8"?>
    <createCloudRedisManualBackupResponse>
        <requestId>6fa60f37-****-****-****-b98ed187c0fd</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
    </createCloudRedisManualBackupResponse>