调用DescribeSQLPlan接口查询基础信息和计划信息。

调试

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

请求参数

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

系统规定参数,取值:DescribeSQLPlan。

DBClusterId String am-bpxxxxxxxx47

实例ID。

ProcessId String 201907241445291720211111570315107****

查询任务ID。

返回数据

名称 类型 示例值 描述
Detail Struct

执行SQL详细信息。

CPUTime Long 35

查询或者ETL任务的总的算子耗时,是个多机多线程累计值,等同于算子消耗。单位:ms。

ClientIP String 0.0.0.0

提交查询的客户端IP地址。

Database String information_schema

建立连接使用的数据库名称。

OutputRows Long 395

任务总的输出行数。

OutputSize Long 3553

任务总的输出数据量。单位:Byte。

PeakMemory Long 2099901

查询或者ETL任务的峰值内存。单位:Byte。

PlanningTime Long 5

查询或者ETL任务的优化耗时。单位:ms。

QueuedTime Long 0

查询或者ETL任务的排队时间。单位:ms。

SQL String SELECT count(*)\nFROM COLUMNS\nGROUP BY COLUMN_NAME

SQL语句。

StartTime String 1598613625178

查询或者ETL任务的提交时间。

State String FINISHED

查询或者ETL任务的最终执行状态。

  • FINISHED:完成。
  • FAILED :失败。
TotalStage Long 3

阶段总个数。

TotalTask Long 6

任务总个数。

TotalTime Long 35

查询或者ETL任务的总耗时。单位:ms。

User String kepler

提交查询的用户名。

OriginInfo String \"queryId\":\"20200828_192025_834_tvyaw\",\"session\":{\"queryId\":\"20200828_192025_834_tvyaw\",\"tstcMin\":0}\"parentId\":0}

SQLPlan详细原始数据。

RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

请求ID。

StageList Array of SqlPlanStage

阶段信息列表。

CPUTimeAvg Long 4

阶段的CPU Time在各个计算节点的平均值。单位:ms。

CPUTimeMax Long 4

阶段的CPU Time在各个计算节点的最大值。单位:ms。

CPUTimeMin Long 4

阶段的CPU Time在各个计算节点的最小值。单位:ms。

InputSizeAvg Long 0

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

InputSizeMax Long 0

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

InputSizeMin Long 0

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

OperatorCost Long 4

该阶段内部总的算子耗时,等同于该阶段的CPU Time,可用于判断查询哪些部分消耗较大计算资源。单位:ms。

PeakMemory Long 141700

该阶段的峰值内存,可用于判断查询哪些部分消耗较大的内存资源。单位:Byte。

ScanSizeAvg Long 0

带数据源的阶段在各个存储节点的扫描数据量的平均值。单位:Byte。

ScanSizeMax Long 0

带数据源的阶段在各个存储节点的扫描数据量的最大值。单位:Byte。

ScanSizeMin Long 0

带数据源的阶段在各个存储节点的扫描数据量的最小值。单位:Byte。

ScanTimeAvg Long 2

带数据源的Stage在各个存储节点读取数据耗时的平均值 单位:ms。

ScanTimeMax Long 2

带数据源的Stage在各个存储节点读取数据耗时的最大值 单位:ms。

ScanTimeMin Long 2

带数据源的Stage在各个存储节点读取数据耗时的最小值 单位:ms。

StageId Integer 2

阶段唯一标识。

State String FINISHED

阶段最终执行状态:

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

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeSQLPlan
&DBClusterId=am-bpxxxxxxxx47
&ProcessId=201907241445291720211111570315107****
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<StageList>
    <ScanSizeAvg>0</ScanSizeAvg>
    <ScanSizeMin>0</ScanSizeMin>
    <PeakMemory>141700</PeakMemory>
    <StageId>2</StageId>
    <CPUTimeMax>4</CPUTimeMax>
    <ScanTimeAvg>2</ScanTimeAvg>
    <ScanTimeMin>2</ScanTimeMin>
    <InputSizeMax>0</InputSizeMax>
    <ScanSizeMax>0</ScanSizeMax>
    <InputSizeAvg>0</InputSizeAvg>
    <InputSizeMin>0</InputSizeMin>
    <State>FINISHED</State>
    <ScanTimeMax>2</ScanTimeMax>
    <OperatorCost>4</OperatorCost>
    <CPUTimeAvg>4</CPUTimeAvg>
    <CPUTimeMin>4</CPUTimeMin>
</StageList>
<OriginInfo>\"queryId\":\"20200828_192025_834_tvyaw\",\"session\":{\"queryId\":\"20200828_192025_834_tvyaw\",\"tstcMin\":0}\"parentId\":0}</OriginInfo>
<Detail>
    <TotalTask>6</TotalTask>
    <OutputSize>3553</OutputSize>
    <User>kepler</User>
    <PeakMemory>2099901</PeakMemory>
    <TotalStage>3</TotalStage>
    <StartTime>1598613625178</StartTime>
    <ClientIP>0.0.0.0</ClientIP>
    <CPUTime>35</CPUTime>
    <SQL>SELECT count(*)\nFROM COLUMNS\nGROUP BY COLUMN_NAME</SQL>
    <QueuedTime>0</QueuedTime>
    <State>FINISHED</State>
    <PlanningTime>5</PlanningTime>
    <TotalTime>35</TotalTime>
    <Database>information_schema</Database>
    <OutputRows>395</OutputRows>
</Detail>

JSON 格式

{
    "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
    "StageList": {
        "ScanSizeAvg": 0,
        "ScanSizeMin": 0,
        "PeakMemory": 141700,
        "StageId": 2,
        "CPUTimeMax": 4,
        "ScanTimeAvg": 2,
        "ScanTimeMin": 2,
        "InputSizeMax": 0,
        "ScanSizeMax": 0,
        "InputSizeAvg": 0,
        "InputSizeMin": 0,
        "State": "FINISHED",
        "ScanTimeMax": 2,
        "OperatorCost": 4,
        "CPUTimeAvg": 4,
        "CPUTimeMin": 4
    },
    "OriginInfo": "\\\"queryId\\\":\\\"20200828_192025_834_tvyaw\\\",\\\"session\\\":{\\\"queryId\\\":\\\"20200828_192025_834_tvyaw\\\",\\\"tstcMin\\\":0}\\\"parentId\\\":0}",
    "Detail": {
        "TotalTask": 6,
        "OutputSize": 3553,
        "User": "kepler",
        "PeakMemory": 2099901,
        "TotalStage": 3,
        "StartTime": 1598613625178,
        "ClientIP": "0.0.0.0",
        "CPUTime": 35,
        "SQL": "SELECT count(*)\\nFROM COLUMNS\\nGROUP BY COLUMN_NAME",
        "QueuedTime": 0,
        "State": "FINISHED",
        "PlanningTime": 5,
        "TotalTime": 35,
        "Database": "information_schema",
        "OutputRows": 395
    }
}

错误码

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

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