调用DescribeSQLPlan查询基础信息和计划信息_云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

调用DescribeSQLPlan接口查询目标SQL，例如查询语句或ETL（Extract Transform Load）任务语句的计划信息。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 ID。说明您可以调用 DescribeDBClusters 接口查看目标地域下所有 AnalyticDB MySQL 集群的详情，包括集群 ID。	am-****************
ProcessId	string	是	任务 ID。说明您可以调用 DescribeProcessList 接口查看目标 SQL 的任务 ID。	202105271604431720161662490345*******

返回参数

名称	类型	描述	示例值
	object	详情。
RequestId	string	请求 ID。	22D6DEF0-CBC7-4388-A41C-D5FD62******
StageList	array<object>	计划阶段的信息列表。
	object	详情。
State	string	该计划阶段的最终执行状态，取值范围如下： FINISHED：完成。 CANCELED：取消。 ABORTED：中止。 FAILED：失败。	FINISHED
CPUTimeAvg	long	该阶段的`CPU Time`在各个计算节点的平均值，单位为毫秒（ms）。	5984
CPUTimeMax	long	该阶段的`CPU Time`在各个计算节点的最大值，单位为毫秒（ms）。	5984
OperatorCost	long	该阶段内部总的算子耗时，等同于该阶段的 CPU Time，可用于判断查询哪些部分消耗了较多的计算资源。单位为毫秒（ms）。	5984
ScanTimeMax	long	带数据扫描算子的阶段在各个存储节点读取数据耗时的最大值，单位为毫秒（ms）。	0
InputSizeMax	long	阶段在各个计算节点的输入数据量的最大值，单位为 Byte。	173
StageId	integer	阶段 ID。	1
ScanSizeMax	long	带数据扫描算子的阶段在各个存储节点的扫描数据量的最大值，单位为 Byte。	0
CPUTimeMin	long	该阶段的`CPU Time`在各个计算节点的最小值，单位为毫秒（ms）。	47
ScanTimeMin	long	带数据扫描算子的阶段在各个存储节点读取数据耗时的最小值，单位为毫秒（ms）。	0
ScanSizeMin	long	带数据扫描算子的阶段在各个存储节点的扫描数据量的最小值，单位为 Byte。	0
InputSizeMin	long	阶段在各个计算节点的输入数据量的最小值，单位为 Byte。	173
PeakMemory	long	执行目标 SQL 时的峰值内存，单位为 Byte。	74208
ScanTimeAvg	long	带数据扫描算子的阶段在各个存储节点读取数据耗时的平均值，单位为毫秒（ms）。	0
ScanSizeAvg	long	带数据扫描算子的阶段在各个存储节点的扫描数据量的平均值，单位为 Byte。	0
InputSizeAvg	long	阶段在各个计算节点的输入数据量的平均值，单位为 Byte。	173
OriginInfo	string	SQL Plan 的详细原始数据。	{\"queryId\":\"20210527_160443_10581_hdhzr\",\"session\":{\"queryId\":\"20210527_160443_10581_hdhzr\",\"hasSharedStage\":false,\"parentId\":0}}
Detail	object	目标 SQL 的详细执行信息。
SQL	string	SQL 语句。	INSERT OVERWRITE INTO hdfs_import_external\nSELECT *\nFROM adb_hdfs_import_source
OutputSize	long	目标 SQL 语句的总输出数据量，单位为 Byte。	9
State	string	目标 SQL 语句的最终执行状态，取值范围如下： FINISHED：完成。 FAILED ：失败。	FINISHED
OutputRows	long	目标 SQL 的总输出行数。	1
User	string	提交目标 SQL 语句的用户名。	test_acc
StartTime	string	目标 SQL 语句的执行开始时间，格式为 Unix 时间戳，单位为毫秒。	1622102683243
TotalStage	long	目标 SQL 中包含的总阶段个数。	4
QueuedTime	long	执行目标 SQL 的排队时间，单位为毫秒（ms）。	0
TotalTime	long	目标 SQL 的执行总耗时，单位为毫秒（ms）。	2340
TotalTask	long	目标 SQL 中包含的总任务个数。	4
Database	string	执行目标 SQL 的数据库名称。	adb_demo
PeakMemory	long	执行目标 SQL 时的峰值内存，单位为 Byte。	441802
ClientIP	string	提交目标 SQL 语句的客户端 IP 地址。	172.16.*.*
PlanningTime	long	执行目标 SQL 时生成执行计划的时间，单位为毫秒（ms）。	86
CPUTime	long	执行目标 SQL 时，算子处理数据单元的总耗时，是多服务器多线程上的累计值。单位为毫秒（ms）。	6100

示例

正常返回示例

JSON格式

{
  "RequestId": "22D6DEF0-CBC7-4388-A41C-D5FD62******",
  "StageList": [
    {
      "State": "FINISHED",
      "CPUTimeAvg": 5984,
      "CPUTimeMax": 5984,
      "OperatorCost": 5984,
      "ScanTimeMax": 0,
      "InputSizeMax": 173,
      "StageId": 1,
      "ScanSizeMax": 0,
      "CPUTimeMin": 47,
      "ScanTimeMin": 0,
      "ScanSizeMin": 0,
      "InputSizeMin": 173,
      "PeakMemory": 74208,
      "ScanTimeAvg": 0,
      "ScanSizeAvg": 0,
      "InputSizeAvg": 173
    }
  ],
  "OriginInfo": "{\\\"queryId\\\":\\\"20210527_160443_10581_hdhzr\\\",\\\"session\\\":{\\\"queryId\\\":\\\"20210527_160443_10581_hdhzr\\\",\\\"hasSharedStage\\\":false,\\\"parentId\\\":0}}",
  "Detail": {
    "SQL": "INSERT OVERWRITE INTO hdfs_import_external\\nSELECT *\\nFROM adb_hdfs_import_source",
    "OutputSize": 9,
    "State": "FINISHED",
    "OutputRows": 1,
    "User": "test_acc",
    "StartTime": "1622102683243",
    "TotalStage": 4,
    "QueuedTime": 0,
    "TotalTime": 2340,
    "TotalTask": 4,
    "Database": "adb_demo",
    "PeakMemory": 441802,
    "ClientIP": "172.16.***.***",
    "PlanningTime": 86,
    "CPUTime": 6100
  }
}

错误码

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

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

变更历史

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

暂无变更历史