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 recoveryDescribeCrossRegionBackupPolicy
Copy page
Download PDF
Backup and recovery
DescribeCrossRegionBackupPolicy
Copy page
Download PDF
DescribeCrossRegionBackupPolicy

Call the DescribeCrossRegionBackupPolicy API to query the cross-region 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 the DescribeDBInstances API to query the basic information of all Redis instances in the target region, including the instance ID.

Response parameters

Name
Type
Example
Description
InstanceId
String
redis-cn0212gzmh2xs****
Instance ID.
Active
Boolean
true

Whether the cross-regional backup function of the current instance is enabled or not, and the value range is as follows:

  • true: Cross-regional backup is enabled.
  • false: Cross-regional backup is not enabled.
CrossBackupRegion
String
ap-southeast-3
The ID of the destination region for cross-regional backup.
TTL
Integer
7
The retention days for cross-regional backup files are 7 days by default.

Sample request 

POST https://redis.cn-beijing.volcengineapi.com/?Action=DescribeCrossRegionBackupPolicy&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****"
}

Sample response 

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****10023228002****",
        "Action": "DescribeCrossRegionBackupPolicy",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstanceId": "redis-cn0212gzmh2xs****",
        "Active": true,
        "CrossBackupRegion": "cn-shanghai",
        "TTL": 7
    }
}

Error codes

For more information, refer to Error codes.

Last updated: 2025.07.02 15:58:44