全部产品
Search

搜索本产品

    云原生数据仓库AnalyticDB：DescribeDiagnosisSQLInfo - 查询诊断SQL信息

    文档中心

    云原生数据仓库AnalyticDB：DescribeDiagnosisSQLInfo - 查询诊断SQL信息

    更新时间：Nov 08, 2024

    查看某个SQL的执行详情，包括执行计划、运行信息、资源使用、自诊断结果等。

    调试

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

    授权信息

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

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

    请求参数

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

    集群 ID。

    说明 您可以调用 DescribeDBClusters 接口查看目标地域下 AnalyticDB MySQL 数仓版集群的集群 ID。
    		am-bp1r053byu48p****
    RegionIdstring是

    地域 ID。

    说明 您可以调用 DescribeRegions 接口查看 AnalyticDB MySQL 支持的地域 ID。
    		cn-hangzhou
    ProcessIdstring是

    查询 ID。

    说明 您可以调用 DescribeDiagnosisRecords 接口查看指定的 AnalyticDB MySQL 集群中 SQL 摘要信息，包括查询 ID。
    		2021070216432217201616806503453******
    ProcessStartTimelong是

    SQL 语句的执行开始时间，格式为 Unix 时间戳，单位为毫秒（ms）。

    说明 您可以调用 DescribeDiagnosisRecords 接口查看指定的 AnalyticDB MySQL 集群中 SQL 摘要信息，包括 SQL 语句的执行开始时间。
    		1625215402000
    ProcessStatestring是

    SQL 语句的状态，取值如下：

    • running：执行中。
    • finished：已完成。
    • failed：执行失败。
    说明 您可以调用 DescribeDiagnosisRecords 接口查看指定的 AnalyticDB MySQL 集群中 SQL 摘要信息，包括 SQL 语句的状态信息。
    		running
    Langstring是

    设置下载文件的文件标题以及部分错误信息的语言，支持如下语言：

    • zh：简体中文。
    • en：英文。
    • ja：日语。
    • zh-tw：繁体中文。
    		zh
    ProcessRcHoststring是

    执行 SQL 语句的 AnalyticDB MySQL 前端节点 IP 和端口信息。

    说明 您可以调用 DescribeDiagnosisRecords 接口查看指定的 AnalyticDB MySQL 集群中 SQL 摘要信息，包括前端节点 IP 和端口信息。
    		192.45.***.***:3145

    返回参数

    名称类型描述示例值
    object

    详情。

    DiagnosisSQLInfostring

    SQL 的执行详情，包括详细的 SQL 语句、统计信息、执行计划和算子信息等。

    		{ "DiagnosisSQLInfo": { "hasSharedStage": false, "resourceGroup": "user_default", "cost": 274, "queuedTime": 0, "outputDataSize": 9, "scheduled": true, "query": "/*+display=tpch_q14*/SELECT 100.00 * SUM(CASE WHEN p_type LIKE 'PROMO%' THEN l_extendedprice * (1 - l_discount) ELSE 0 END) / SUM(l_extendedprice * (1 - l_discount)) AS promo_revenue FROM lineitem l, part p WHERE l_partkey = p_partkey AND l_shipdate >= DATE '1995-09-01' AND l_shipdate < DATE '1995-09-01' + INTERVAL '1' MONTH", "outputRows": 1, "userName": "test_user", "parentId": 0, "maxOutputRows": 200000, "scanSize": 8247470, "peakMemory": 13188295, "startTime": 1626330527632, "state": "FINISHED", "endTime": 1626330527905, "writeTableRows": 0, "scanRows": 351966 } }
    RequestIdstring

    请求 ID。

    		1
    StageInfosarray<object>

    查询的分阶段执行信息。

    StageInfosobject

    查询的分阶段执行信息。

    InputRowslong

    Stage 总的输入行数。

    		123
    InputDataSizelong

    Stage 总的输入数据量，单位为 Bytes。

    		2341
    OutputRowslong

    Stage 总的输出行数。

    		231
    OutputDataSizelong

    Stage 总的输出数据量，单位为 Bytes。

    		12344
    PeakMemorylong

    Stage 总的峰值内存，单位为 Bytes。

    		3421
    OperatorCostlong

    Stage 的算子累积耗时，单位为毫秒（ms）。

    		2341
    StageIdstring

    StageID。

    		Stage[26]
    Statestring

    Stage 状态。

    枚举值：
    • FAILED：FAILED。
    • RUNNING：RUNNING。
    • FINISHED：FINISHED。
    		RUNNING
    Progressdouble

    Stage 的执行进度。

    		0.3

    示例

    正常返回示例

    JSON格式

    {
  "DiagnosisSQLInfo": "{     \"DiagnosisSQLInfo\": {         \"hasSharedStage\": false,         \"resourceGroup\": \"user_default\",         \"cost\": 274,         \"queuedTime\": 0,         \"outputDataSize\": 9,         \"scheduled\": true,         \"query\": \"/*+display=tpch_q14*/SELECT 100.00 * SUM(CASE WHEN p_type LIKE 'PROMO%' THEN l_extendedprice * (1 - l_discount) ELSE 0 END) / SUM(l_extendedprice * (1 - l_discount)) AS promo_revenue FROM lineitem l, part p WHERE l_partkey = p_partkey AND l_shipdate &gt;= DATE '1995-09-01' AND l_shipdate &lt; DATE '1995-09-01' + INTERVAL '1' MONTH\",         \"outputRows\": 1,         \"userName\": \"test_user\",         \"parentId\": 0,         \"maxOutputRows\": 200000,         \"scanSize\": 8247470,         \"peakMemory\": 13188295,         \"startTime\": 1626330527632,         \"state\": \"FINISHED\",         \"endTime\": 1626330527905,         \"writeTableRows\": 0,         \"scanRows\": 351966     } }",
  "RequestId": "1",
  "StageInfos": [
    {
      "InputRows": 123,
      "InputDataSize": 2341,
      "OutputRows": 231,
      "OutputDataSize": 12344,
      "PeakMemory": 3421,
      "OperatorCost": 2341,
      "StageId": "Stage[26]",
      "State": "RUNNING",
      "Progress": 0.3
    }
  ]
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2023-08-31API 内部配置变更，不影响调用查看变更详情