DescribeInstanceCrossBackupPolicy - ApsaraDB RDS - Alibaba Cloud ドキュメントセンター

Queries the cross-region backup settings of an instance.

Operation description

Supported database engines

MySQL
PostgreSQL
SQL Server

References

Note Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	rm-uf6wjk5xxxxxxxxxx
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
LogBackupEnabledTime	string	The time when cross-region log backup was enabled on the instance. 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
BackupEnabled	string	The status of the cross-region backup feature on the instance. Valid values: Disable Enable	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 before a rollback. LockByDiskQuota: The instance is automatically locked because its storage capacity is exhausted and the instance is inaccessible.	Unlock
EngineVersion	string	The database engine version.	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 Enable	Enable
RequestId	string	The request ID.	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
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
CrossBackupRegion	string	The ID of the destination region where the cross-region backup files of the instance are stored.	cn-shanghai
DBInstanceId	string	The instance ID.	rm-uf6wjk5xxxxxxxxxx
Engine	string	The database engine of the instance.	mysql
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
DBInstanceDescription	string	The name of the instance. It must be 2 to 256 characters in length. The value can contain letters, digits, underscores (_), and hyphens (-), and must start with a letter. Note The value cannot start with http:// or https://.	Test database

Examples

Sample success responses

JSONformat

{
  "LogBackupEnabledTime": "2019-06-12T05:44:21Z",
  "BackupEnabled": "Enable",
  "DBInstanceStatus": "Running",
  "LockMode": "Unlock",
  "EngineVersion": "5.6",
  "RegionId": "cn-hangzhou",
  "LogBackupEnabled": "Enable",
  "RequestId": "CB7667B2-72C8-497B-9BD8-3B343CEF51AB",
  "RetentType": 1,
  "Retention": 15,
  "CrossBackupType": "1",
  "CrossBackupRegion": "cn-shanghai",
  "DBInstanceId": "rm-uf6wjk5xxxxxxxxxx",
  "Engine": "mysql",
  "BackupEnabledTime": "2019-06-12T05:44:21Z",
  "DBInstanceDescription": "Test database\n"
}

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	InvalidPage.notFound	Page not found.	The specified parameters are not found. Check your parameters.

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

Change history

Change time

Summary of changes

Operation

2022-09-01

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 404 change
	delete Error Codes: 400
	delete Error Codes: 403