You need to enable JavaScript to run this app.
Cache for Redis

Cache for Redis

  • Documentation
    • Cache for RedisDevelopment reference (Control plane)API referenceBackup and recoveryModifyCrossRegionBackupPolicy
Copy page
Download PDF
Backup and recovery
ModifyCrossRegionBackupPolicy
Copy page
Download PDF
ModifyCrossRegionBackupPolicy

Call ModifyCrossRegionBackupPolicy API to modify the cross-regional backup policy of the target Redis instance.

Request type

Synchronous request.

Request parameters

Name
Type
Required
Example
Description
InstanceId
String
Yes
redis-cn0212gzmh2xs****

Instance ID.

tip

You can call DescribeDBInstances to query the basic information of all Redis instances in a target region, including instance IDs.

Active
Boolean
Yes
true

Whether to enable the cross-regional backup function, the value range is as follows:

  • true: Enable cross-regional backup.
  • false: Do not enable cross-regional backup.
CrossBackupRegion
String
No
cn-shanghai

The ID of the destination region for cross-regional backup.

tip

  • When the cross-regional backup function is enabled (i.e., Active is true), this parameter is required.
  • When the cross-regional backup function is disabled (i.e., Active is true), this parameter does not take effect.
  • You can call the DescribeAvailableCrossRegion API to query the list of regions that can be used as the destination region for cross-regional backup in the target Redis instance.
ClientToken
String
No
WbiAlPqJM6tMoSOYhTOYhT
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

The current API has no specified response parameters. For more information, see Response structure.

Sample request 

POST https://redis.cn-beijing.volcengineapi.com/?Action=ModifyCrossRegionBackupPolicy&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****",
    "Active": true,
    "CrossBackupRegion": "cn-shanghai"
}

Sample response 

{
    "ResponseMetadata": {
        "RequestId": "20230604110420100210023228002****",
        "Action": "ModifyCrossRegionBackupPolicy",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": null
}

Error codes

For more information, refer to Error codes.

Last updated: 2025.08.14 10:45:21