Cache for Redis
Cache for Redis
Cache for Redis
Document
What's new
Product announcements
Overview
Billing
Quick start
User guide
Instance management
High availability
Multi-availability-zone disaster recovery solution
Modifying instance configuration
Tag management
Network connection management
Connecting to instance
Account and access authorization
Data security
Monitoring and alerts
Backup and recovery
Backup
Parameter management
Parameter template management
Event management
Performance analysis
Best practices
Data migration and synchronization
Development reference (Control plane)
API reference
Region and availability zone
Instance management
Modifying instance configuration
Billing management
Backup and recovery
Parameter management
Connection management
Account management
Allowlist management
Log management
Performance analysis
Failure drills
SDK reference
Terraform reference
Development reference (Data plane)
Supported commands
Redis open-source command support
FAQ
Errors and exceptions
- Documentation
Cache for RedisDevelopment reference (Control plane)API referenceBackup and recoveryCreateBackup
Copy page
Download PDFBackup and recovery
CreateBackup
Copy pageDownload PDFCreateBackup
Call the CreateBackup API to create backup manually for a specified Redis instance.
Request type
Asynchronous request.
Precautions
Only primary-secondary instances (i.e., where InstanceClass is PrimarySecondary) support calling this API. Single node instances (i.e., where InstanceClass is Standalone) do not support backup and recovery operations and cannot call this API. For details about the feature differences between the two instance types, refer to Feature differences.
Debugging
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
Parameters | Type | Required | Example | Description |
InstanceId | String | Yes | redis-cn02aqusft7ws**** | Instance ID. tip You can call the DescribeDBInstances API to query the basic information of all Redis instances in the target region, including the instance ID. |
BackupPointName | String | No | testbackup | Set a backup name for manually created backups. To set a backup name, it must meet all of the following conditions:
tip If no backup name is set, the backup ID generated when the backup task was created will be used by default. |
ClientToken | String | No | WbiAlPqJM6tMoSOYhT**** | To ensure the idempotence of requests and prevent duplicate submission of requests. The client generates the parameter values to ensure the uniqueness among different requests. Values are case-sensitive, no more than 127 ASCII characters. |
Response parameters
Parameters | Type | Example | Description |
InstanceId | String | redis-cn02aqusft7ws**** | Instance ID. |
BackupPointId | String | b-cn02xmmrp751i9cdzcphjmk4**** | The backup ID generated when creating a backup task. |
Example
Request example
POST https://redis.cn-beijing.volcengineapi.com/?Action=CreateBackup&Version=2020-12-07 HTTP/1.1
Host: redis.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
"InstanceId":"redis-cn0212gzmh2xs****"
}
Response example
{
"ResponseMetadata": {
"RequestId": "202207271102110102252431250149xxxx",
"Action": "CreateBackup",
"Version": "2020-12-07",
"Service": "Redis",
"Region": "cn-beijing"
},
"Result": {
"BackupPointId": "b-cn02xmmrp751i9cdzcphjmk4****",
"InstanceId": "redis-cn02aqusft7ws****"
}
}
Error code
Last updated: 2026.09.21 15:01:09
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
