DescribeInstanceCrossBackupPolicy - ApsaraDB RDS - Alibaba Cloud Documentation Center

You can call the DescribeInstanceCrossBackupPolicy operation to query cross-region backup settings of an instance.

Operation Description

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 Enable cross-region backups for an ApsaraDB RDS for PostgreSQL instance.

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:DescribeInstanceCrossBackupPolicy	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. You can call the DescribeRegions operation to query the IDs of regions.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object
LogBackupEnabledTime	string	The time when cross-region log backup was enabled on the instance. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2019-06-12T05:44:21Z
BackupEnabled	string	The status of the cross-region backup feature on the instance. Valid values: Disable: The feature is disabled. Enable: The feature is enabled.	Enable
DBInstanceStatus	string	The status of the instance. For more information, see Instance state table.	Running
LockMode	string	The lock status of the instance. Valid values: Unlock: The instance is not locked. ManualLock: The instance is manually locked. LockByExpiration: The instance is automatically locked due to instance expiration. LockByRestoration: The instance is automatically locked due to instance restoration. LockByDiskQuota: The instance is automatically locked because its storage capacity is exhausted and the instance is inaccessible.	Unlock
EngineVersion	string	The database engine version of the instance.	5.6
RegionId	string	The region ID of the instance.	cn-hangzhou
LogBackupEnabled	string	The status of the cross-region log backup feature on the instance. Valid values: Disable: The feature is disabled. Enable: The feature is enabled.	Enable
RequestId	string	The ID of the request.	CB7667B2-72C8-497B-9BD8-3B343CEF51AB
RetentType	integer	The policy that is used to retain the cross-region backup files of the instance. Default value: 1. The value 1 indicates that the cross-region backup files of the instance are retained based on the specified retention period.	1
Retention	integer	The number of days for which the cross-region backup files of the instance are retained. Valid values: 7 to 1825.	15
CrossBackupRegion	string	The ID of the region in which the cross-region backup files of the instance is stored.	cn-shanghai
CrossBackupType	string	The policy that is used to save the cross-region backup files of the instance. Default value: 1. The value 1 indicates that all cross-region backup files are saved.	1
DBInstanceId	string	The ID of the instance	rm-uf6wjk5xxxxxxxxxx
Engine	string	The type of the database engine.	mysql
DBInstanceDescription	string	The name of the instance. It must be 2 to 256 characters in length. The name can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter. NoteThe name cannot start with http:// or https://.	Test database
BackupEnabledTime	string	The point in time at which the cross-region backup feature is enabled. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-06-12T05:44:21Z

Examples

Sample success responses

JSONformat

{
	"DBInstanceStatusDesc": "ACTIVATION",
	"LockMode": "Unlock",
	"BackupEnabledTime": "2019-06-12T05:44:21Z",
	"CrossBackupType": "1",
	"LogBackupEnabled": "Enable",
	"BackupEnabled": "Enable",
	"RetentType": 1,
	"DBInstanceId": "rm-bpxxxxx",
	"DBInstanceDescription": "",
	"Retention": 15,
	"Engine": "mysql",
	"LogBackupEnabledTime": "2019-06-12T05:44:21Z",
	"CrossBackupRegion": "cn-shanghai",
	"StorageOwner": "rds",
	"RegionId": "cn-hangzhou",
	"RequestId": "CB7667B2-72C8-497B-9BD8-3B343CEF51AB",
	"EngineVersion": "5.6",
	"StorageType": "oss",
	"Endpoint": "",
	"DBInstanceStatus": "1"
}

XMLformat

<DescribeInstanceCrossBackupPolicyResponse>
<DBInstanceStatusDesc>ACTIVATION</DBInstanceStatusDesc>
	<LockMode>Unlock</LockMode>
	<BackupEnabledTime>2019-06-12T05:44:21Z</BackupEnabledTime>
	<CrossBackupType>1</CrossBackupType>
	<LogBackupEnabled>Enable</LogBackupEnabled>
	<BackupEnabled>Enable</BackupEnabled>
	<RetentType>1</RetentType>
	<DBInstanceId>rm-bpxxxxx</DBInstanceId>
	<DBInstanceDescription></DBInstanceDescription>
	<Retention>15</Retention>
	<Engine>mysql</Engine>
	<LogBackupEnabledTime>2019-06-12T05:44:21Z</LogBackupEnabledTime>
	<CrossBackupRegion>cn-shanghai</CrossBackupRegion>
	<StorageOwner>rds</StorageOwner>
	<RegionId>cn-hangzhou</RegionId>
	<RequestId>CB7667B2-72C8-497B-9BD8-3B343CEF51AB</RequestId>
	<EngineVersion>5.6</EngineVersion>
	<StorageType>oss</StorageType>
	<Endpoint></Endpoint>
	<DBInstanceStatus>1</DBInstanceStatus>
</DescribeInstanceCrossBackupPolicyResponse>

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidRegion.Format	Specified Region is not valid.	The region ID is invalid. Check the region ID.
403	CrossBackupNotSupport	Specified region not support cross region backup.	Cross-zone backup is not supported in the specified region.
404	not found	Page not found.	-

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