DescribeSQLPlanTask - 查询计划任务信息 - 云原生数据仓库AnalyticDB

调用DescribeSQLPlanTask查询任务信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
adb:DescribeSQLPlanTask	get	*DBCluster `acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	无	无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	实例 ID。	am-bp1xxxxxxxx47
ProcessId	string	是	查询任务 ID。	201907241445301720211111570315107****
StageId	string	是	任务所属阶段。	1785135913****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	1AD222E9-E606-4A42-BF6D-8A4442913CEF
TaskList	array<object>	任务列表。
SqlPlanTask	object
OutputSize	long	任务的输出数据量。单位：Byte。	945
ScanCost	long	带数据源的任务的扫描数据耗时。单位：ms。	0
InputSize	long	任务的输入数据量。单位：Byte。	3763
State	string	任务最终执行状态： FINISHED：完成。 CANCELED：取消。 ABORTED：中止。 FAILED：失败。	FINISHED
OperatorCost	long	任务在某个节点的算子总耗时，是个多线程累加值，可以用于判断计算是否存在长尾。单位：ms。	3
OutputRows	long	任务的输出数据行数。	105
ScanSize	long	带数据源的任务的扫描数据量。单位：Byte。	0
ElapsedTime	long	任务从创建到结束的时间差。单位：ms。	10
ScanRows	long	带数据源的任务的扫描数据行数。	0
PeakMemory	long	任务在某个节点的峰值内存。单位：Byte。	898576
TaskId	integer	任务 ID。	198877623
InputRows	long	任务的输入数据行数。	105

示例

正常返回示例

JSON格式

{
  "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
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史