You can call this operation to query the information 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 DescribeSQLPlanTask

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

The ID of the cluster.
ProcessId String Yes 201907241445301720211111570315107****

The ID of the task.
StageId String Yes 1785135913****

The stage of the task.

Response parameters

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

The ID of the request.
TaskList Array of SqlPlanTask

The list of tasks.
ElapsedTime Long 10

The time elapsed from when the task was created to when the task was complete. Unit: milliseconds.

InputRows Long 105

The number of input rows in the task.
InputSize Long 3763

The amount of input data in the task. Unit: bytes.
OperatorCost Long 3

The total amount of time consumed by operators in the task on a specific node. This parameter can be used to determine whether long tails occur in computing. Unit: milliseconds.

OutputRows Long 105

The number of output rows in the task.
OutputSize Long 945

The amount of output data in the task. Unit: bytes.
PeakMemory Long 898576

The peak memory of the task on a specific node. Unit: bytes.
ScanCost Long 0

The time consumed to scan data from a data source in the task. Unit: milliseconds.
ScanRows Long 0

The number of rows scanned from a data source in the task.
ScanSize Long 0

The amount of data scanned from a data source in the task. Unit: bytes.
State String FINISHED

The final execution status of the task. Valid values:

  • FINISHED
  • CANCELED
  • ABORTED
  • FAILED
TaskId Integer 198877623

The ID of the task.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeSQLPlanTask
&<Common request parameters>

Sample success responses

XML format 

<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<TaskList>
    <OutputSize>945</OutputSize>
    <TaskId>198877623</TaskId>
    <InputSize>3763</InputSize>
    <PeakMemory>898576</PeakMemory>
    <ElapsedTime>10</ElapsedTime>
    <InputRows>105</InputRows>
    <ScanRows>0</ScanRows>
    <ScanCost>0</ScanCost>
    <State>FINISHED</State>
    <OutputRows>105</OutputRows>
    <OperatorCost>3</OperatorCost>
    <ScanSize>0</ScanSize>
</TaskList>

JSON format 

{
    "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
    "TaskList": {
        "OutputSize": 945,
        "TaskId": 198877623,
        "InputSize": 3763,
        "PeakMemory": 898576,
        "ElapsedTime": 10,
        "InputRows": 105,
        "ScanRows": 0,
        "ScanCost": 0,
        "State": "FINISHED",
        "OutputRows": 105,
        "OperatorCost": 3,
        "ScanSize": 0
    }
}

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.