You can call this operation to query the details of a backup plan in a recovery period.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeRestoreRangeInfo |
The parameter specified by the system. Value: DescribeRestoreRangeInfo. |
BackupPlanId | String | Yes | dbstooi0XXXX |
The ID of the backup plan. |
BeginTimestampForRestore | Long | Yes | 1554560477000 |
The beginning of the time range when data can be restored. Valid values: 1554560477000. |
EndTimestampForRestore | Long | Yes | 1554560477000 |
The end of the time range during which the data can be recovered. Valid value: 1554560477000. |
RegionId | String | No | cn-hangzhou |
Region ID, call DescribeRegions to view the regions supported by DBS. |
ClientToken | String | No | ETnLKlblzczshOTUbOCzxxxxxxx |
The client token that is used to ensure the idempotency of the request. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
ErrCode | String | Param.NotFound |
The error code. |
ErrMessage | String | The specified parameter %s value is not valid. |
The error message. |
HttpStatusCode | Integer | 200 |
The HTTP status code. |
Items | Array of DBSRecoverRange |
The information about the recoverable time period. |
|
DBSRecoverRange | |||
BeginTimestampForRestore | Long | 1554560477000 |
The start time of restoration. |
EndTimestampForRestore | Long | 1554560477000 |
The end of the time range where data can be restored. |
FullBackupList | Array of FullBackupDetail |
If you set RangeType to point, this parameter specifies the valid time range. Backup point information. |
|
FullBackupDetail | |||
BackupSetId | String | dbs1hvbXXXXX |
The ID of the backup set. |
EndTime | Long | 1554560477000 |
The end time of full Backup. Valid value: 1554560477000. |
StartTime | Long | 1554560477000 |
The start time of full Backup. Valid value: 1554560477000. |
RangeType | String | point |
The type of the time period in which the data can be restored. Valid values:
|
SourceEndpointInstanceID | String | rm-bp1p8cXXXXX |
The ID of the ApsaraDB RDS instance to query. |
SourceEndpointInstanceType | String | rm-bp1p8cXXXXX |
The location of the database. |
RequestId | String | 7A851299-A739-4801-B4BC-FC30A535B538 |
The ID of the request. |
Success | Boolean | false |
Indicates whether the call was successful. |
Examples
Sample requests
http(s)://dbs-api.cn-hangzhou.aliyuncs.com/? Action=DescribeRestoreRangeInfo
&BackupPlanId=dbstooi0XXXX
&BeginTimestampForRestore=1554560477000
&EndTimestampForRestore=1554560477000
&<Common request parameters>
Sample success responses
XML
format
<DescribeJobErrorCodeReponse>
<HttpStatusCode>200</HttpStatusCode>
<RequestId>7A851299-A739-4801-B4BC-FC30A535B538</RequestId>
<Items>
<DBSRecoverRange>
<BeginTimestampForRestore>1554560477000</BeginTimestampForRestore>
<EndTimestampForRestore>1554560477000</EndTimestampForRestore>
<FullBackupList>
<FullBackupDetail>
<BackupSetId>dbs1hvbXXXXX</BackupSetId>
<EndTime>1554560477000</EndTime>
<StartTime>1554560477000</StartTime>
</FullBackupDetail>
</FullBackupList>
<RangeType>point</RangeType>
<SourceEndpointInstanceID>rm-bp1p8cXXXXX</SourceEndpointInstanceID>
<SourceEndpointInstanceType>rm-bp1p8cXXXXX</SourceEndpointInstanceType>
</DBSRecoverRange>
</Items>
</DescribeJobErrorCodeReponse>
JSON
format
{
"HttpStatusCode": 200,
"RequestId": "7A851299-A739-4801-B4BC-FC30A535B538",
"Items": {
"DBSRecoverRange": {
"BeginTimestampForRestore": 1554560477000,
"EndTimestampForRestore": 1554560477000,
"FullBackupList": [
{
"FullBackupDetail": {
"BackupSetId": "dbs1hvbXXXXX",
"EndTime": 1554560477000,
"StartTime": 1554560477000
}
}
],
"RangeType": "point",
"SourceEndpointInstanceID": "rm-bp1p8cXXXXX",
"SourceEndpointInstanceType": "rm-bp1p8cXXXXX"
}
}
}
Error codes
For a list of error codes, visit the API Error Center.