You can call the DescribeLocalAvailableRecoveryTime operation to query the time range to which an ApsaraDB RDS instance can be restored.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeLocalAvailableRecoveryTime

The operation that you want to perform. Set the value to DescribeLocalAvailableRecoveryTime.

DBInstanceId String Yes rm-uf6wjk5xxxxxxx

The ID of the instance.

Region String No cn-hangzhou

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

ResourceGroupId String No rg-acfmy*****

The ID of the resource group.

Response parameters

Parameter Type Example Description
RecoveryEndTime String 2020-03-20T08:41:29Z

The end of the time range to which the instance can be restored.

DBInstanceId String rm-uf6wjk5xxxxxxx

The ID of the instance.

RequestId String 14E986AC-0F27-4FFB-8EED-9A8A3A2A0309

The ID of the request.

RecoveryBeginTime String 2020-03-16T07:59:18Z

The start of the time range to which the instance can be restored.

Examples

Sample requests

http(s)://rds.aliyuncs.com/?Action=DescribeLocalAvailableRecoveryTime
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLocalAvailableRecoveryTimeResponse>
<RecoveryEndTime>2020-03-20T08:41:29Z</RecoveryEndTime>
<RecoveryBeginTime>2020-03-16T07:59:18Z</RecoveryBeginTime>
<RequestId>14E986AC-0F27-4FFB-8EED-9A8A3A2A0309</RequestId>
<DBInstanceId>rm-uf6wjk5xxxxxxx</DBInstanceId>
</DescribeLocalAvailableRecoveryTimeResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RecoveryEndTime" : "2020-03-20T08:41:29Z",
  "RecoveryBeginTime" : "2020-03-16T07:59:18Z",
  "RequestId" : "14E986AC-0F27-4FFB-8EED-9A8A3A2A0309",
  "DBInstanceId" : "rm-uf6wjk5xxxxxxx"
}

Error codes

HTTP status code Error code Error message Description
400 ParameterLeastAssociate Must input at least one optional parameter The error message returned because neither of the optional parameters is specified.
400 ParameterAbsence Necessary parameter is absence. The error message returned because the required parameters are not specified.
400 MissingUID The request is missing a uid parameter. The error message returned because the account that you use does not exist.
403 IncorrectDBInstanceCharacterType Current DB Instance character_type does not support this operation. The error message returned because the character type of the current instance does not support this operation.
403 IncorrectDBInstanceState Current DB instance state does not support this operation. The error message returned because this operation is not supported when the instance is in the current state.
403 IncorrectDBInstanceEngine Current DB Instance engine does not support this operation. The error message returned because the database engine of the instance does not support this operation.
403 IncorrectDBInstanceLockMode Current DB instance lock mode does not support this operation. The error message returned because the instance is locked.

For a list of error codes, visit the API Error Center.