文档

DescribeSQLPlans - 查询 SQL 执行计划

更新时间:

根据 SQLID 查询诊断系统存储的 SQL 执行计划信息。

接口说明

为优化用户体验,云数据库对 SQL 诊断功能进行了升级,本接口已下线并由新的接口替代,详情请参见 【通知】云数据库诊断管理 API 接口下线

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

租户 ID。

t2mr3oae0****
SQLIdstring

SQLID。

8D6E84****0B8FB1823D199E2CA1****

返回参数

名称类型描述示例值
object

请求的返回结果。

RequestIdstring

请求 ID。

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
SQLPlansobject []

执行计划列表信息。

HitCountinteger

命中次数。

3
OutlineDatastring

Outline 数据。

/*+ BEGIN_OUTLINE_DATA FULL(@\"SEL$1\" \"testdb1.bmsql_order_line\"@\"SEL$1\") END_OUTLINE_DATA*/
AvgExecutionMSfloat

平均执行时间 (ms)。

1
PlanUnionHashstring

SQL 执行计划在诊断系统内部的唯一标识。

859ef7ee****b23ac98cdeb2476f****
OutlineIdlong

OutlineID。

-1
AvgExecutionTimeMSlong

数据库使用此执行计划的平均执行时间,单位毫秒。

288
PlanIdinteger

SQL 执行计划在数据库内部的 ID。

9114
OutlineTimelong

绑定时间。

1641492303000
OutlineTimeUTCStringstring

绑定时间(零时区)。

2022-01-06T18:05:03Z
PlanFullstring

SQL 的完整执行计划。

PHY_TABLE_SCAN | bmsql_order_line | 40 ******
NodeIpstring

节点 IP。

i-bp16niirq4zdmgvm****
MergedVersioninteger

合并版本。

132
QuerySQLstring

查询 sql。

SELECT ol_i_id, ***, *** FROM aaa
FirstLoadTimeUTCStringstring

首次加载时间(零时区)。

2022-01-06T18:05:03Z
FirstLoadTimelong

首次加载时间。

1641492303000
PlanInfostring

计划信息。

PHY_TABLE_SCAN

示例

正常返回示例

JSON格式

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "SQLPlans": [
    {
      "HitCount": 3,
      "OutlineData": "/*+ BEGIN_OUTLINE_DATA FULL(@\\\"SEL$1\\\" \\\"testdb1.bmsql_order_line\\\"@\\\"SEL$1\\\") END_OUTLINE_DATA*/",
      "AvgExecutionMS": 1,
      "PlanUnionHash": "859ef7ee****b23ac98cdeb2476f****",
      "OutlineId": -1,
      "AvgExecutionTimeMS": 288,
      "PlanId": 9114,
      "OutlineTime": 1641492303000,
      "OutlineTimeUTCString": "2022-01-06T18:05:03Z",
      "PlanFull": "PHY_TABLE_SCAN | bmsql_order_line | 40 ******",
      "NodeIp": "i-bp16niirq4zdmgvm****",
      "MergedVersion": 132,
      "QuerySQL": "SELECT ol_i_id, ***, *** FROM aaa",
      "FirstLoadTimeUTCString": "2022-01-06T18:05:03Z",
      "FirstLoadTime": 1641492303000,
      "PlanInfo": "PHY_TABLE_SCAN"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
2014InternalErrorThe request processing has failed due to some unknown error.内部错误

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

变更历史

变更时间变更内容概要操作
2022-01-17OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:2014
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈