exportBackupToObjectStorage

Available in VPC

Send Cloud DB for Cache backup files to Object Storage.
To send backup files to Object Storage, Object Storage buckets for storing and searching backup files must be created in advance. For more information, See Object Storage Guide.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
GET \| POST	/vredis/v2/exportBackupToObjectStorage

Request headers

For information about the headers common to all Cloud DB for Cache APIs, see Cloud DB for Cache request headers.

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`regionCode`	String	Optional	Region code of the Cloud DB for Cache instance whose backup files you want to send to Object Storage See getRegionList. First Region of the `getRegionList` query result (default)
`fileName`	String	Required	Backup file name See getCloudCacheBackupDetailList and getCloudCacheManualBackupDetailList.
`bucketName`	String	Required	Name of the Object Storage bucket the backup file will be sent to getCloudCacheBucketList
`cloudRedisInstanceNo`	String	Required	Cloud DB for Cache instance number See getCloudCacheInstanceList.
`backupTypeMode`	String	Required	Cloud DB for Cache backup type `SYSTEM` \| `MANUAL` `SYSTEM`: system backup `MANUAL`: manual backup
`responseFormatType`	String	Optional	Format of the response result `xml` (default) \| `json`

Request example

The request example is as follows:

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}'

Response

This section describes the response format.

Response status codes

For information about the HTTP status codes common to all Cloud DB for Cache (VPC) APIs, see Cloud DB for Cache (VPC) response status codes.

Response example

The response example is as follows:

If responseFormatType=json

{
    "exportBackupToObjectStorageResponse": {
        "requestId": "afee84ad-****-****-****-d4b359e85dca",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

If responseFormatType=xml (default)

<?xml version="1.0" encoding="UTF-8"?>
<exportBackupToObjectStorageResponse>
    <requestId>afee84ad-****-****-****-d4b359e85dca</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
</exportBackupToObjectStorageResponse>