VPC環境で利用できます。
Cloud DB for Cacheのバックアップファイルを Object Storageに転送します。
バックアップファイルを Object Storageに転送する前に、バックアップファイルの保存・検索用の Object Storageバケットが作成されている必要があります。詳細は、Object Storageガイドをご参照ください。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | POST | /vredis/v2/exportBackupToObjectStorage |
リクエストヘッダ
Cloud DB for Cache (VPC) APIで共通して使用されるヘッダの詳細は、Cloud DB for Cache (VPC)のリクエストヘッダをご参照ください。
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
regionCode |
String | Optional | バックアップファイルを Object Storageに転送する Cloud DB for Cacheインスタンスのリージョンコード
|
fileName |
String | Required | バックアップファイル名 |
bucketName |
String | Required | バックアップファイルが転送される Object Storageのバケット名 |
cloudRedisInstanceNo |
String | Required | Cloud DB for Cacheインスタンス番号 |
backupTypeMode |
String | Required | Cloud DB for Cacheのバックアップタイプ
|
responseFormatType |
String | Optional | レスポンス結果の形式
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vredis/v2/exportBackupToObjectStorage
?regionCode=KR
&fileName=20240702
&bucketName=redis-backup
&cloudRedisInstanceNo=****511
&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": "afee84ad-****-****-****-d4b359e85dca", "returnCode": "0", "returnMessage": "success" } } -
responseFormatType=xml(デフォルト)の場合<?xml version="1.0" encoding="UTF-8"?> <exportBackupToObjectStorageResponse> <requestId>afee84ad-****-****-****-d4b359e85dca</requestId> <returnCode>0</returnCode> <returnMessage>success</returnMessage> </exportBackupToObjectStorageResponse>