Docs

Cache for Redis

Backup and recovery

DescribeCrossRegionBackupPolicy

Call the DescribeCrossRegionBackupPolicy API to query the cross-region backup policy of target Redis instance.

Request type

Synchronous request.

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.

Go to debug

Request parameters

Parameters	Type	Required	Example	Description
InstanceId	String	Yes	redis-cn0212gzmh2xs1111	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

Parameters	Type	Example	Description
InstanceId	String	redis-cn0212gzmh2xs1111	Instance ID.
Active	Boolean	true	Whether the cross-region backup feature of the current instance is enabled. The valid values are: true: cross-region backup is enabled. false: cross-regional backup is not enabled.
CrossBackupRegion	String	cn-shanghai	The destination region ID for cross-region backup.
TTL	Integer	7	Retention period for cross-regional backup files; defaults to 7 days.

Example

Request example

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-cn0212gzmh2xs1111"​
}​

Response example

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

Error code

For more details, see Error code.

Last updated: 2026.09.21 15:01:10