You can call this operation to view the progress of a backup plan PreCheck and the progress of the restoration job.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribePreCheckProgressList |
The operation that you want to perform. Valid values: DescribePreCheckProgressList |
BackupPlanId | String | No | dbstooi01XXXX |
The ID of the backup plan. |
RestoreTaskId | String | No | dbasdsaXXXX |
The ID of the restoration task. |
RegionId | String | No | cn-hangzhou |
The region ID of the instance. You can call DescribeRegions query. |
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. |
Items | Array of PreCheckProgressDetail |
Progress details list. |
|
PreCheckProgressDetail | |||
BootTime | Long | 1583734969000 |
The start time. Value: 1554560477000. |
ErrMsg | String | java.lang.RuntimeException: Could not find any schema ...... |
The error message. |
FinishTime | Long | 1583734969000 |
The time when the instance is completed. Valid value: 1554560477000. |
Item | String | CHECK_OTHER |
The code of the check item. |
JobId | String | uvk8f6fxnq5s |
The progress ID. |
Names | String | CHECK_OTHER |
The group of check items. |
OrderNum | String | 10 |
The sequence number. |
State | String | warning |
The status of the progress. Valid values:
|
HttpStatusCode | Integer | 200 |
The HTTP status code. |
ErrMessage | String | The specified parameter %s value is not valid. |
The error message. |
Progress | Integer | 100 |
Pre-check progress. Valid values: 0 to 100. |
RequestId | String | C4A45FE1-A903-470D-B113-F12A4DF942AB |
The ID of the request. |
Status | String | failed |
The PreCheck status. Valid values:
|
Success | Boolean | true |
Indicates whether the request succeeded. |
Examples
Sample requests
http(s)://dbs-api.cn-hangzhou.aliyuncs.com/? Action=DescribePreCheckProgressList
&<Common request parameters>
Sample success responses
XML
format
</DescribePreCheckProgressListReponse>
<Status>failed</Status>
<Progress>20</Progress>
<RequestId>C4A45FE1-A903-470D-B113-F12A4DF942AB</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Items>
<PreCheckProgressDetail>
<Names>CHECK_MYSQL_PASSOWRD_FORMAT_DETAIL</Names>
<Item>CHECK_MYSQL_PASSOWRD_FORMAT</Item>
<OrderNum>90</OrderNum>
<State>init</State>
<BootTime>1583734969000</BootTime>
<JobId>uvk8f6fxnq5s</JobId>
</PreCheckProgressDetail>
</Items>
<ErrMessage>java.lang.RuntimeException: Could not find any schema ...... </ErrMessage>
<Success>true</Success>
</DescribePreCheckProgressListReponse>
JSON
format
{
"Status": "failed",
"Progress": 20,
"RequestId": "C4A45FE1-A903-470D-B113-F12A4DF942AB",
"HttpStatusCode": 200,
"Items": {
"PreCheckProgressDetail": [
{
"Names": "CHECK_MYSQL_PASSOWRD_FORMAT_DETAIL",
"Item": "CHECK_MYSQL_PASSOWRD_FORMAT",
"OrderNum": "90",
"State": "init",
"BootTime": 1583734969000,
"JobId": "uvk8f6fxnq5s"
}
]
},
"ErrMessage": "java.lang.RuntimeException: Could not find any schema ......",
"Success": true
}
Error codes
For a list of error codes, visit the API Error Center.