全部产品
Search
文档中心

云原生数据仓库AnalyticDB MySQL版:DescribeSQLPlan - 查询基础信息和计划信息

更新时间:Mar 22, 2024

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
adb:DescribeSQLPlanRead
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

请求参数

名称类型必填描述示例值
DBClusterIdstring

集群 ID。

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

任务 ID。

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

返回参数

名称类型描述示例值
object

详情。

RequestIdstring

请求 ID。

22D6DEF0-CBC7-4388-A41C-D5FD62******
StageListobject []

计划阶段的信息列表。

Statestring

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

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

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

5984
CPUTimeMaxlong

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

5984
OperatorCostlong

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

5984
ScanTimeMaxlong

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

0
InputSizeMaxlong

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

173
StageIdinteger

阶段 ID。

1
ScanSizeMaxlong

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

0
CPUTimeMinlong

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

47
ScanTimeMinlong

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

0
ScanSizeMinlong

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

0
InputSizeMinlong

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

173
PeakMemorylong

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

74208
ScanTimeAvglong

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

0
ScanSizeAvglong

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

0
InputSizeAvglong

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

173
OriginInfostring

SQL Plan 的详细原始数据。

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

目标 SQL 的详细执行信息。

SQLstring

SQL 语句。

INSERT OVERWRITE INTO hdfs_import_external\nSELECT *\nFROM adb_hdfs_import_source
OutputSizelong

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

9
Statestring

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

  • FINISHED:完成。
  • FAILED :失败。
FINISHED
OutputRowslong

目标 SQL 的总输出行数。

1
Userstring

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

test_acc
StartTimestring

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

1622102683243
TotalStagelong

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

4
QueuedTimelong

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

0
TotalTimelong

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

2340
TotalTasklong

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

4
Databasestring

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

adb_demo
PeakMemorylong

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

441802
ClientIPstring

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

172.16.***.***
PlanningTimelong

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

86
CPUTimelong

执行目标 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错误码错误信息描述
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

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

变更历史

变更时间变更内容概要操作
暂无变更历史