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 recoveryDescribeAvailableCrossRegion
Copy page
Download PDF
Backup and recovery
DescribeAvailableCrossRegion
Copy page
Download PDF
DescribeAvailableCrossRegion

Call the DescribeAvailableCrossRegion API to query the list of regions that can be used as the destination for cross-regional backups in the target Redis instance.

Request type

Synchronous request.

Request parameters

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

Instance ID. After specified, it can query the regions where the instance can be used for cross-regional backup.

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
TargetRegionIds
String[]
[ "cn-shanghai", "cn-guangzhou" ]
The list of regions that can be used as the destination regions for cross-regional backup in the current instance.

Sample request 

POST https://redis.cn-beijing.volcengineapi.com/?Action=DescribeAvailableCrossRegion&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": "DescribeAvailableCrossRegion",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "TargetRegionIds": [
            "cn-shanghai",
            "cn-guangzhou"
        ]
    }
}

Error codes

For more information, refer to Error codes.

Last updated: 2025.07.16 11:11:00