DescribeCrossRegionBackups - ApsaraDB RDS - Alibaba Cloud Documentation Center

You can call the DescribeCrossRegionBackups operation to query the cross-region data backup files of an instance.

Operation Description

For more information about how to query the cross-region log backup files of an RDS instance, see DescribeCrossRegionLogBackupFiles.

Before you call this operation, make sure that the instance runs one of the following database engines:

MySQL. For more information, see Back up an ApsaraDB RDS for MySQL instance across regions.
SQL Server. For more information, see Back up an ApsaraDB RDS for SQL Server instance across regions.
PostgreSQL. For more information, see Back up an ApsaraDB RDS for PostgreSQL instance across regions.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
rds:DescribeCrossRegionBackups	READ	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance.	rm-uf6wjk5xxxxxxxxxx
RegionId	string	Yes	The region ID of the instance.	cn-hangzhou
CrossBackupRegion	string	No	The ID of the destination region where the cross-region data backup file is stored.	cn-shanghai
CrossBackupId	integer	No	The ID of the cross-region data backup file. NoteYou must specify the CrossBackupId parameter. Alternatively, you must specify the StartTime and EndTime parameters.	14562
StartTime	string	No	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2019-05-30T12:10:00Z
EndTime	string	No	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2019-06-15T12:10:00Z
PageSize	integer	No	The number of entries to return on each page. Valid values: 30 50 100 Default value: 30.	30
PageNumber	integer	No	The number of the page to return. Valid values: any non-zero positive integer. Default value: 1.	1
BackupId	integer	No	The ID of the cross-region data backup file.	603524***
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmy*****

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end of the time range that is queried.	2019-06-15T12:10:00Z
StartTime	string	The beginning of the time range that is queried.	2019-05-30T12:10:00Z
RequestId	string	The ID of the request.	60912B41-7579-4B5D-B289-8856030F0A6A
PageRecordCount	integer	The number of cross-region data backup files on the current page.	30
TotalRecordCount	integer	The total number of entries returned.	100
PageNumber	integer	The page number of the returned page. Valid values: any non-zero positive integer. Default value: 1.	1
RegionId	string	The region ID of the instance.	cn-hangzhou
Items	object []	An array that consists of details of the cross-region data backup files.
ConsistentTime	string	The point in time that is indicated by the data in the cross-region data backup file.	2019-06-12T05:44:46Z
DBInstanceStorageType	string	The storage type. Valid values: local_ssd: local SSD. This is the recommended storage type. cloud_ssd: standard SSD. cloud_essd: enhanced SSD (ESSD).	ssd
CrossBackupId	integer	The ID of the cross-region data backup file.	14377
BackupType	string	The type of the cross-region data backup. Valid values: F: full data backup I: incremental data backup	F
BackupStartTime	string	The time when the cross-region data backup started.	2019-05-30T12:10:00Z
CrossBackupSetLocation	string	The location where the cross-region data backup file is stored.	oss
InstanceId	integer	The ID of the instance. This parameter is used to determine whether the instance that generates the cross-region data backup file is a primary or secondary instance.	8161055
CrossBackupDownloadLink	string	The external URL from which you can download the cross-region data backup file.	http://rdsddrbak-shanghai.oss-cn-shanghai.aliyuncs.com/xxxxx
BackupEndTime	string	The time when the cross-region data backup file was generated.	2019-06-15T12:10:00Z
EngineVersion	string	The version of the database engine.	5.6
BackupSetStatus	integer	The status of the cross-region data backup. Valid values: 0: The cross-region data backup is successful. 1: The cross-region data backup failed.	0
CrossBackupSetFile	string	The name of the compressed package that contains the cross-region data backup file.	cn-hangzhou_rm-xxxxx_hins81xxx_data_20190612134426_qp.xb
BackupSetScale	integer	The level at which the cross-region data backup file is generated. 0: instance-level backup 1: database-level backup	0
CrossBackupSetSize	long	The size of the cross-region data backup file. Unit: bytes.	5312836
CrossBackupRegion	string	The ID of the destination region where the cross-region data backup file of the instance is stored.	cn-shanghai
Category	string	The RDS edition of the instance. Valid values: Basic: Basic Edition. HighAvailability: High-availability Edition. Finance: Enterprise Edition. This edition is supported only by the China site (aliyun.com).	HighAvailability
Engine	string	The engine of the database.	mysql
BackupMethod	string	The method that is used to generate the cross-region data backup file. Valid values: L: logical backup P: physical backup	P
RestoreRegions	array	An array that consists of the regions to which the cross-region data backup file can be restored.
	string	The ID of the region.	cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "EndTime": "2019-06-15T12:10:00Z",
  "StartTime": "2019-05-30T12:10:00Z",
  "RequestId": "60912B41-7579-4B5D-B289-8856030F0A6A",
  "PageRecordCount": 30,
  "TotalRecordCount": 100,
  "PageNumber": 1,
  "RegionId": "cn-hangzhou",
  "Items": {
    "Item": [
      {
        "ConsistentTime": "2019-06-12T05:44:46Z",
        "DBInstanceStorageType": "ssd",
        "CrossBackupId": 14377,
        "BackupType": "F",
        "BackupStartTime": "2019-05-30T12:10:00Z",
        "CrossBackupSetLocation": "oss",
        "InstanceId": 8161055,
        "CrossBackupDownloadLink": "http://rdsddrbak-shanghai.oss-cn-shanghai.aliyuncs.com/xxxxx",
        "BackupEndTime": "2019-06-15T12:10:00Z",
        "EngineVersion": "5.6",
        "BackupSetStatus": 0,
        "CrossBackupSetFile": "cn-hangzhou_rm-xxxxx_hins81xxx_data_20190612134426_qp.xb",
        "BackupSetScale": 0,
        "CrossBackupSetSize": 5312836,
        "CrossBackupRegion": "cn-shanghai",
        "Category": "HighAvailability",
        "Engine": "mysql",
        "BackupMethod": "P",
        "RestoreRegions": {
          "RestoreRegion": [
            "cn-hangzhou"
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterAbsence	Necessary param is absence.	-
400	InvalidParameters.Format	Specified parameter is not valid.	-
400	InvalidRegion.Format	Specified Region is not valid.	The region ID is invalid. Check the region ID.
400	InvalidStartTime.Format	Specified start time is not valid.	The start time is invalid.
400	InvalidEndTime.Format	Specified end time is not valid.	The end time is invalid. Check the end time.
400	InvalidTime.Format	Specified time is not valid.	The time format is invalid.
403	CrossBackupNotSupport	Specified region not support cross region backup.	Cross-zone backup is not supported in the specified region.
404	InvalidPage.notFound	Page not found.	The specified parameters are not found. Check your parameters.
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.	The RDS instance cannot be found, is deleted, or does not support the operation.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2022-09-01

The error codes of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	Error Codes 404 change
	delete Error Codes: 400
	delete Error Codes: 403