exportBackupToObjectStorage
- Print
- PDF
exportBackupToObjectStorage
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Send Cloud DB for Redis 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 the Object Storage Guide.
Request
The following describes the request format for the endpoint. The request format is as follows:
Method | URI |
---|---|
GET, POST | /exportBackupToObjectStorage |
Request headers
For headers common to Cloud DB for Redis APIs, see Cloud DB for Redis request headers.
Request parameter
The following describes the parameters.
Field | Type | Required | Description |
---|---|---|---|
regionCode | String | Optional | Region code of the Cloud DB for Redisinstance whose backup file you want to send to Object Storage
|
fileName | String | Required | Name of the backup file
|
bucketName | String | Required | Name of the Object Storage bucket the backup file will be sent to
|
cloudRedisInstanceNo | String | Required | Cloud DB for Redis instance number
|
backupTypeMode | String | Required | Cloud DB for Redis backup type
|
responseFormatType | String | Optional | Format of the response result
|
Request example
The following is a sample request.
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
The following describes the response format.
Response status codes
For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.
Response example
The following is a sample response.
- 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>
Was this article helpful?