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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeSQLPlan

系统规定参数。取值:DescribeSQLPlan

DBClusterId String am-****************

集群ID。

说明 您可以调用DescribeDBClusters接口查看目标地域下所有AnalyticDB MySQL集群的详情,包括集群ID。
ProcessId String 202105271604431720161662490345*******

任务ID。

说明 您可以调用DescribeSlowLogRecords接口查看目标SQL的任务ID。

返回数据

名称 类型 示例值 描述
RequestId String 22D6DEF0-CBC7-4388-A41C-D5FD62******

请求ID。

StageList Array of SqlPlanStage

计划阶段的信息列表。

State String FINISHED

该计划阶段的最终执行状态,取值范围如下:

  • FINISHED:完成。
  • CANCELED:取消。
  • ABORTED:中止。
  • FAILED:失败。
CPUTimeAvg Long 5984

该阶段的CPU Time在各个计算节点的平均值,单位为毫秒(ms)。

CPUTimeMax Long 5984

该阶段的CPU Time在各个计算节点的最大值,单位为毫秒(ms)。

OperatorCost Long 5984

该阶段内部总的算子耗时,等同于该阶段的CPU Time,可用于判断查询哪些部分消耗了较多的计算资源。单位为毫秒(ms)。

ScanTimeMax Long 0

带数据扫描算子的阶段在各个存储节点读取数据耗时的最大值,单位为毫秒(ms)。

InputSizeMax Long 173

阶段在各个计算节点的输入数据量的最大值,单位为Byte。

StageId Integer 1

阶段ID。

ScanSizeMax Long 0

带数据扫描算子的阶段在各个存储节点的扫描数据量的最大值,单位为Byte。

CPUTimeMin Long 47

该阶段的CPU Time在各个计算节点的最小值,单位为毫秒(ms)。

ScanTimeMin Long 0

带数据扫描算子的阶段在各个存储节点读取数据耗时的最小值,单位为毫秒(ms)。

ScanSizeMin Long 0

带数据扫描算子的阶段在各个存储节点的扫描数据量的最小值,单位为Byte。

InputSizeMin Long 173

阶段在各个计算节点的输入数据量的最小值,单位为Byte。

PeakMemory Long 74208

执行目标SQL时的峰值内存,单位为Byte。

ScanTimeAvg Long 0

带数据扫描算子的阶段在各个存储节点读取数据耗时的平均值,单位为毫秒(ms)。

ScanSizeAvg Long 0

带数据扫描算子的阶段在各个存储节点的扫描数据量的平均值,单位为Byte。

InputSizeAvg Long 173

阶段在各个计算节点的输入数据量的平均值,单位为Byte。

OriginInfo String {\"queryId\":\"20210527_160443_10581_hdhzr\",\"session\":{\"queryId\":\"20210527_160443_10581_hdhzr\",\"hasSharedStage\":false,\"parentId\":0}}

SQL Plan的详细原始数据。

Detail Object

目标SQL的详细执行信息。

SQL String INSERT OVERWRITE INTO hdfs_import_external\nSELECT *\nFROM adb_hdfs_import_source

SQL语句。

OutputSize Long 9

目标SQL语句的总输出数据量,单位为Byte。

State String FINISHED

目标SQL语句的最终执行状态,取值范围如下:

  • FINISHED:完成。
  • FAILED :失败。
OutputRows Long 1

目标SQL的总输出行数。

User String test_acc

提交目标SQL语句的用户名。

StartTime String 1622102683243

目标SQL语句的执行开始时间,格式为Unix时间戳,单位为毫秒。

TotalStage Long 4

目标SQL中包含的总阶段个数。

QueuedTime Long 0

执行目标SQL的排队时间,单位为毫秒(ms)。

TotalTime Long 2340

目标SQL的执行总耗时,单位为毫秒(ms)。

TotalTask Long 4

目标SQL中包含的总任务个数。

Database String adb_demo

执行目标SQL的数据库名称。

PeakMemory Long 441802

执行目标SQL时的峰值内存,单位为Byte。

ClientIP String 172.16.***.***

提交目标SQL语句的客户端IP地址。

PlanningTime Long 86

执行目标SQL时生成执行计划的时间,单位为毫秒(ms)。

CPUTime Long 6100

执行目标SQL时,算子处理数据单元的总耗时,是多服务器多线程上的累计值。单位为毫秒(ms)。

示例

请求示例

http(s)://adb.aliyuncs.com/?Action=DescribeSQLPlan
&DBClusterId=am-****************
&ProcessId=202105271604431720161662490345*******
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSQLPlanResponse>
    <RequestId>22D6DEF0-CBC7-4388-A41C-D5FD62******</RequestId>
    <StageList>
        <ScanSizeMin>0</ScanSizeMin>
        <ScanSizeAvg>0</ScanSizeAvg>
        <StageId>0</StageId>
        <PeakMemory>264960</PeakMemory>
        <CPUTimeMax>47</CPUTimeMax>
        <ScanTimeMin>0</ScanTimeMin>
        <ScanTimeAvg>0</ScanTimeAvg>
        <InputSizeMax>1023</InputSizeMax>
        <InputSizeMin>1023</InputSizeMin>
        <InputSizeAvg>1023</InputSizeAvg>
        <ScanSizeMax>0</ScanSizeMax>
        <State>FINISHED</State>
        <OperatorCost>47</OperatorCost>
        <ScanTimeMax>0</ScanTimeMax>
        <CPUTimeMin>47</CPUTimeMin>
        <CPUTimeAvg>47</CPUTimeAvg>
    </StageList>
    <StageList>
        <ScanSizeMin>0</ScanSizeMin>
        <ScanSizeAvg>0</ScanSizeAvg>
        <StageId>1</StageId>
        <PeakMemory>74208</PeakMemory>
        <CPUTimeMax>5984</CPUTimeMax>
        <ScanTimeMin>0</ScanTimeMin>
        <ScanTimeAvg>0</ScanTimeAvg>
        <InputSizeMax>173</InputSizeMax>
        <InputSizeMin>173</InputSizeMin>
        <InputSizeAvg>173</InputSizeAvg>
        <ScanSizeMax>0</ScanSizeMax>
        <State>FINISHED</State>
        <OperatorCost>5984</OperatorCost>
        <ScanTimeMax>0</ScanTimeMax>
        <CPUTimeMin>5984</CPUTimeMin>
        <CPUTimeAvg>5984</CPUTimeAvg>
    </StageList>
    <StageList>
        <ScanSizeMin>0</ScanSizeMin>
        <ScanSizeAvg>0</ScanSizeAvg>
        <StageId>2</StageId>
        <PeakMemory>102634</PeakMemory>
        <CPUTimeMax>18</CPUTimeMax>
        <ScanTimeMin>0</ScanTimeMin>
        <ScanTimeAvg>0</ScanTimeAvg>
        <InputSizeMax>173</InputSizeMax>
        <InputSizeMin>173</InputSizeMin>
        <InputSizeAvg>173</InputSizeAvg>
        <ScanSizeMax>0</ScanSizeMax>
        <State>FINISHED</State>
        <OperatorCost>18</OperatorCost>
        <ScanTimeMax>0</ScanTimeMax>
        <CPUTimeMin>18</CPUTimeMin>
        <CPUTimeAvg>18</CPUTimeAvg>
    </StageList>
    <StageList>
        <ScanSizeMin>36</ScanSizeMin>
        <ScanSizeAvg>36</ScanSizeAvg>
        <StageId>3</StageId>
        <PeakMemory>0</PeakMemory>
        <CPUTimeMax>51</CPUTimeMax>
        <ScanTimeMin>10</ScanTimeMin>
        <ScanTimeAvg>10</ScanTimeAvg>
        <InputSizeMax>36</InputSizeMax>
        <InputSizeMin>36</InputSizeMin>
        <InputSizeAvg>36</InputSizeAvg>
        <ScanSizeMax>36</ScanSizeMax>
        <State>FINISHED</State>
        <OperatorCost>51</OperatorCost>
        <ScanTimeMax>10</ScanTimeMax>
        <CPUTimeMin>51</CPUTimeMin>
        <CPUTimeAvg>51</CPUTimeAvg>
    </StageList>
    <OriginInfo>{"queryId":"20210527_160443_10581_hdhzr","session":{"queryId":"20210527_160443_10581_hdhzr","hasSharedStage":false,"parentId":0}}</OriginInfo>
    <Detail>
        <TotalTask>4</TotalTask>
        <OutputSize>9</OutputSize>
        <User>test_acc</User>
        <TotalStage>4</TotalStage>
        <PeakMemory>441802</PeakMemory>
        <StartTime>1622102683243</StartTime>
        <ClientIP>172.16.***.***</ClientIP>
        <SQL>INSERT OVERWRITE INTO hdfs_import_external
SELECT *
FROM adb_hdfs_import_source</SQL>
        <CPUTime>6100</CPUTime>
        <QueuedTime>0</QueuedTime>
        <State>FINISHED</State>
        <Database>adb_demo</Database>
        <TotalTime>2340</TotalTime>
        <PlanningTime>86</PlanningTime>
        <OutputRows>1</OutputRows>
    </Detail>
</DescribeSQLPlanResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

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