exportBackupToObjectStorage

VPC環境で利用できます。

Cloud DB for Cacheのバックアップファイルを Object Storageに転送します。
バックアップファイルを Object Storageに転送する前に、バックアップファイルの保存・検索用の Object Storageバケットが作成されている必要があります。詳細は、Object Storageガイドをご参照ください。

exportBackupToObjectStorage API

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

リクエスト

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

メソッド	URI
GET \| POST	/exportBackupToObjectStorage

参考

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	バックアップファイルを Object Storageに転送する Cloud DB for Cacheインスタンスのリージョンコード getRegionListを参照 `getRegionList`照会結果の最初のリージョン(デフォルト)
`fileName`	String	Required	バックアップファイル名 getCloudCacheBackupDetailList、getCloudCacheManualBackupDetailListを参照
`bucketName`	String	Required	バックアップファイルが転送される Object Storageのバケット名 getCloudCacheBucketList
`cloudCacheInstanceNo`	String	Required	Cloud DB for Cacheインスタンス番号 getCloudCacheInstanceListを参照
`backupTypeMode`	String	Required	Cloud DB for Cacheのバックアップタイプ `SYSTEM` \| `MANUAL` `SYSTEM`: System Backup `MANUAL`: Manual Backup
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vcache/v2/exportBackupToObjectStorage
?regionCode=KR
&fileName=2021****
&bucketName=cache-******
&cloudCacheInstanceNo=****821
&backupTypeMode=SYSTEM'
--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の場合

{
  "exportBackupToObjectStorageResponse": {
    "requestId": "18fe5b24-2663-4cc7-8a2a-aa0f44c0c46c",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

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


<exportBackupToObjectStorageResponse>
    <requestId>fb01982a-8107-4a13-ac0d-1720f551cc61</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
</exportBackupToObjectStorageResponse>