DescribeCrossRegionBackups--Cache for Redis-Volcengine

Docs

Cache for Redis

Backup and recovery

DescribeCrossRegionBackups

Call the DescribeCrossRegionBackups API to query the list of cross-regional backup files.

Request type

Synchronous request.

Request parameters

Name	Type	Required	Example	Description
Scope	String	No	AccountInstances	Backup query range. The value range is as follows: `OneInstance` (default): Query backups within a single instance. `AccountInstances`: Query backups under the current account.
InstanceId	String	No	redis-cn0212gzmh2xs****	Instance ID. Precise query. tip When the backup query scope is a single instance (i.e., the value of `Scope` is `OneInstance`), this parameter is required. You can call the DescribeDBInstances API to query the basic information of all Redis instances in the target region, including the instance ID. If this parameter is left blank, it means that the instance ID condition is not used for filtering.
Status	String	No	Available	Backup status. The value range is as follows: `Creating`: Creating. `Available`: Available. `Unavailable`: Unavailable. `Deleting`: Deleting. tip For more details on the backup status, refer to Backup status.
StartTime	String	No	2024-08-22T07:51:09Z	Query start time. The format is `yyyy-MM-ddTHH:mm:ssZ` (UTC). tip If this parameter is set, the query end time (i.e., `EndTime`) parameter must also be filled in. If this parameter is left blank, it means that no time range filtering is used.
EndTime	String	No	2024-08-22T07:51:12Z	Query end time. The format is `yyyy-MM-ddTHH:mm:ssZ` (UTC). tip If the query start time (i.e., `StartTime`) is set, this parameter is required. The query end time should be later than the start time. If this parameter is left blank, it means not using the time range filtering.
BackupStrategyList	String[]	No	[ "AutomatedBackup", "ManualBackup" ]	Backup method list. The value range is as follows: `ManualBackup`: Manual backup. `AutomatedBackup`: Automatic backup. tip Multiple backup methods are supported to be passed in simultaneously, separated by English commas (,). If this parameter is left blank, it means no backup method filtering is used.
BackupPointName	String	No	testbackup	The backup name at the backup time point. Fuzzy query is supported. tip When the backup query scope is a single instance (that is, the `Scope` value is `OneInstance`), this parameter does not take effect. If this parameter is left blank, it means not using the backup name for filtering.
BackupPointId	String	No	b-cn02xmmrp751i9cdzcphjmk4****	The backup ID at the backup time point. Fuzzy query is supported. tip This parameter takes effect only when the query scope is the current account (i.e., the value of `Scope` is `AccountInstances`). If this parameter is left blank, it means not using the backup ID for filtering.
ProjectName	String	No	default	The project to which the backup time point then belonged. tip This parameter takes effect only when the query scope is the current account (i.e., the `Scope` value is `AccountInstances`). If this parameter is left blank, it means no filtering by project name is applied.
PageSize	Integer	No	10	Number of records per page. The value is an integer between 1 and 100. tip If the page number (i.e., `PageNumber`) is set, this parameter is required. If this parameter is left blank, it means not using the number of records per page for filtering.
PageNumber	Integer	No	1	The page number of the backup set information list, with a value not exceeding the maximum value of the Integer data type and a starting value of 1. tip If this parameter is set, the number of records per page (i.e., `PageSize`) must also be filled in. If this parameter is left blank, it means that no page number range filtering is used.

Response parameters

Name	Type	Example	Description
Total	Integer	1
Backups	Object[]

Sample request

POST https://redis.cn-beijing.volcengineapi.com/?Action=DescribeCrossRegionBackups&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=****
{
    "Scope": "AccountInstances",
    "PageNumber": 1,
    "PageSize": 10,
    "BackupPointName": "testbackup"
}

Sample response

{
    "ResponseMetadata": {
        "RequestId": "20250418164600DEC6A8C99DC381932EE4d2****",
        "Action": "DescribeCrossRegionBackups",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "Backups": [
            {
                "SourceRegion": "cn-beijing",
                "TargetRegion": "cn-shanghai",
                "BackupPointId": "b-cn02xmmrp751i9cdzcphjmk4****",
                "BackupPointName": "testbackup",
                "BackupStrategy": "ManualBackup",
                "BackupType": "Full",
                "StartTime": "2025-04-14T12:58:19Z",
                "EndTime": "2025-04-14T13:31:17Z",
                "InstanceId": "redis-cn0212gzmh2xs****",
                "InstanceInfo": {
                    "AccountId": 210000****,
                    "ArchType": "Cluster",
                    "ChargeType": "PostPaid",
                    "DeletionProtection": "enabled",
                    "EngineVersion": "5.0",
                    "ExpiredTime": "",
                    "InstanceId": "redis-cn0212gzmh2xs****",
                    "InstanceName": "test",
                    "MaintenanceTime": "02:00-02:59",
                    "NetworkType": "VPC",
                    "RegionId": "cn-beijing",
                    "Replicas": 2,
                    "ShardCapacity": 1024,
                    "ShardNumber": 2,
                    "TotalCapacity": 2048,
                    "VpcId": "vpc-rs5811nceqyov0x58x4****",
                    "ZoneIds": [
                        "cn-beijing-a"
                    ]
                },
                "ProjectName": "default",
                "Size": 486040,
                "Status": "Available",
                "TTL": 7
            }
        ],
        "Total": 1
    }
}

Error codes

For more information, refer to Error codes.

Last updated: 2025.07.02 15:58:44

Cache for Redis

Request type #

Request parameters #

Response parameters #

Sample request #