DescribeAvailableRecoveryTime - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the time range within which data can be restored from a cross-region backup file.

Operation description

Note To view the time range within which you can restore data from a standard backup set, see DescribeBackups.

Supported database engines

ApsaraDB RDS for MySQL instances with local disks

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.

Use the cross-region backup feature

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:DescribeAvailableRecoveryTime	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
CrossBackupId	integer	Yes	The ID of the cross-region data backup file. You can call the DescribeCrossRegionBackups operation to query the backup file ID.	14***
RegionId	string	No	The region ID.	cn-hangzhou
ResourceGroupId	string	No	The resource group ID.	rg-acfmy*****
DBInstanceId	string	No	The instance ID. You can call the DescribeDBInstances operation to query the instance ID.	rm-uf6wjk5*****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RecoveryEndTime	string	The end time to which data can be restored. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-06-12T07:33:12Z
RequestId	string	The request ID.	8CCBF4BA-7CE1-47E1-B49F-E97EA200A40D
CrossBackupId	integer	The ID of the cross-region data backup file.	14377
RecoveryBeginTime	string	The start time from which data can be restored. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-06-12T05:22:29Z
RegionId	string	The region where the source instance resides.	cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "RecoveryEndTime": "2019-06-12T07:33:12Z",
  "RequestId": "8CCBF4BA-7CE1-47E1-B49F-E97EA200A40D",
  "CrossBackupId": 14377,
  "RecoveryBeginTime": "2019-06-12T05:22:29Z",
  "RegionId": "cn-hangzhou"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoAvailableLogBackup	No available log backup.	No available log backup is found.
400	NoAvailableDisasterRestoreBakset	No available disaster restore bakset.	No available restore set is found.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	Your account available limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	Failed to call commodity service return.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedIndia	Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.	Hello customer, this area has been abolished.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400	Price.CommoditySys	Commodity system call exception.	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.	-
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	-
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Your basic information is not complete, please complete your basic information before operation.
403	CrossBackupNotSupport	Specified region not support cross region backup.	Cross-zone backup is not supported in the specified region.
404	InvalidBackupSetID.NotFound	Specified backup set ID does not exist.	The backup set does not exist. Specify an available backup set.
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	View Change Details