All Products
Search
Document Center

AnalyticDB for MySQL:DescribeSQLPlanTask

Last Updated:Mar 15, 2024

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the cluster.

am-bp1xxxxxxxx47
ProcessIdstringYes

The ID of the task.

201907241445301720211111570315107****
StageIdstringYes

The stage of the task.

1785135913****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

1AD222E9-E606-4A42-BF6D-8A4442913CEF
TaskListobject []

The list of tasks.

OutputSizelong

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

945
ScanCostlong

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

0
InputSizelong

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

3763
Statestring

The final execution status of the task. Valid values:

  • FINISHED
  • CANCELED
  • ABORTED
  • FAILED
FINISHED
OperatorCostlong

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.

3
OutputRowslong

The number of output rows in the task.

105
ScanSizelong

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

0
ElapsedTimelong

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

10
ScanRowslong

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

0
PeakMemorylong

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

898576
TaskIdinteger

The ID of the task.

198877623
InputRowslong

The number of input rows in the task.

105

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history