You can call this operation to query the progress of a task.

Debugging

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

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeTaskInfo

The operation that you want to perform. Set the value to DescribeTaskInfo.
DBClusterId String Yes am-bp1xxxxxxxx47

The ID of the cluster.
TaskId Integer Yes 225685759

The ID of the task.

Response parameters

Parameter Type Example Description
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.
TaskInfo Struct

The description of the task.
BeginTime String 2020-01-07T07:39:56Z

The start time of the task. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format.
FinishTime String 2020-01-07T08:08:50Z

The end time of the task. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format.
Progress String 100

The progress of the task. Unit: %.
Status String Finished

The status of the task.

  • Waiting
  • Running
  • Finished
  • Failed
  • Closed
  • Cancel
  • Retry
  • Pause
  • Stop
TaskId Integer 225685759

The ID of the task.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeTaskInfo
&DBClusterId=am-bp1xxxxxxxx47
&TaskId=225685759
&<Common request parameters>

Sample success responses

XML format 

<TaskInfo>
    <Status>Finished</Status>
    <Progress>100</Progress>
    <TaskId>225685759</TaskId>
    <FinishTime>2020-01-07T08:08:50Z</FinishTime>
    <BeginTime>2020-01-07T07:39:56Z</BeginTime>
</TaskInfo>
<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>

JSON format 

{
    "TaskInfo": {
        "Status": "Finished",
        "Progress": 100,
        "TaskId": 225685759,
        "FinishTime": "2020-01-07T08:08:50Z",
        "BeginTime": "2020-01-07T07:39:56Z"
    },
    "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF"
}

Error codes

HttpCode Error code Error message Description
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified DBClusterId parameter does not exist. Check whether you specify the DBClusterId parameter correctly.

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