Query SQL plan task information by using DescribeSQLPlanTask - AnalyticDB - Alibaba Cloud - AnalyticDB

Queries execution details of tasks within a specific stage of a SQL plan.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:DescribeSQLPlanTask

get

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	am-bp1xxxxxxxx47
ProcessId	string	Yes	The task ID.	201907241445301720211111570315107****
StageId	string	Yes	The stage of the task.	1785135913****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
TaskList	array<object>	The task execution details.
	object
ScanCost	integer	The time spent scanning data from the source. Unit: milliseconds.	0
OutputSize	integer	The output data size. Unit: bytes.	945
InputSize	integer	The input data size. Unit: bytes.	3763
State	string	The final execution status of the task. Valid values: FINISHED CANCELED ABORTED FAILED	FINISHED
OperatorCost	integer	The total time consumed by all operators in the task on a node. Useful for detecting compute long tails. Unit: milliseconds.	3
OutputRows	integer	The number of output rows in the task.	105
ScanSize	integer	The size of scanned data from the source. Unit: bytes.	0
ElapsedTime	integer	The elapsed time from task creation to completion. Unit: milliseconds.	10
ScanRows	integer	The number of rows scanned from a data source in the task.	0
PeakMemory	integer	The peak memory usage of the task on a node. Unit: bytes.	898576
TaskId	integer	The task ID.	198877623
InputRows	integer	The number of input rows in the task.	105

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.