DescribeDiagnosisSQLInfo - 查看SQL语句的详细信息

获取AnalyticDB PostgreSQL版实例中指定查询语句的详细信息。

接口说明

本接口用于查看 AnalyticDB PostgreSQL 版实例中指定查询的详细信息,例如查询语句、执行计划文本和执行计划树等。

目前该功能仅支持存储弹性模式实例,且内核版本为 V6.3.10.1 及以上版本。如何查看和升级内核小版本,请参见查看内核小版本版本升级

调试

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

授权信息

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

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

请求参数

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

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
gp-bp12ga6v69h86****
QueryIDstring

查询 ID,即查询的唯一标识。

说明 您可以调用 DescribeDiagnosisRecords 接口获取查询 ID。
71403480878****
Databasestring

数据库名称。

adbtest

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

425AAA6A-63E0-1929-A1CE-3D9036CBC463
QueryIDstring

查询 ID。

71403480878****
SessionIDstring

查询所属的会话 ID。

658****
StartTimelong

查询开始的时间,为毫秒级的 UNIX 时间戳。

1660719602199
Durationinteger

查询运行的总时间,单位为秒(s)。

16
SQLStmtstring

SQL 语句。

select n_live_tup, n_live_tup + n_dead_tup, pg_relation_size(table_name), last_vacuum from pg_stat_user_tables where relid = table_name::regclass
Userstring

用户名。

adbpguser
Databasestring

数据库名称。

adbtest
Statusstring

SQL 执行状态,取值说明:

  • running:执行中。
  • finished:执行完成。
finished
QueryPlanstring

算子信息。

{\"children\":********\"startTime\":1660719602199}
TextPlanstring

查询计划信息。

******
SortedMetricsstring

按照指标的排序结构。

{\"costSort\":******:\"Seq Scan-9\",\"value\":0.0}]}
MaxOutputRowsstring

最大输出行数。

10

QueryPlan 参数说明如下:

名称类型示例值描述
OpertorIDInteger1算子在查询执行计划中的 ID。
OperatorTypeIDinteger10算子类型 ID。
OperatorTypeStringAGG算子类型。
OperatorNameStringAGG-1算子名称。
NodeWidthInteger1执行计划树中,节点在该层的水平位置,从 1 开始。
NodeDepthInteger2执行计划树中,节点所处的深度,从 1 开始。
LevelWidthInteger1执行计划树中,节点所在层的总宽度,从 1 开始。
MaxDepthInteger2执行计划树的最大深度,该值仅 root 节点支持,从 1 开始。
OutputRowsInteger10算子执行过程中输出的数据行数。
InputRowsInteger1000算子执行过程中输入的数据行数。
MemoryFloat100算子占用内存,单位为 KB。
StartTimeString1652843003000算子开始执行的时间。
EndTimeString1652843003100算子结束执行的时间。
DurationFloat6算子执行消耗的时间,单位为毫秒(ms)。
DiskReadSizeFloat55算子从磁盘读取数据量,单位为 Byte。
DiskReadTimeFloat0.1算子从磁盘读取数据消耗的时间,单位为毫秒(ms)。
NetIOSizeFloat3000数据在不同节点间网络传输的数据量,单位为 Byte。
NetIOTimeFloat0.1数据在不同节点间网络传输消耗的时间,单位为毫秒(ms)。
MemoryPercentFloat20.11算子使用内存占比。
DurationPercentFloat16.11算子执行消耗时间占比。
DiskReadSizePercentFloat55.11算子从磁盘读取数据量占比。
DiskReadTimePercentFloat11.11算子从磁盘读取数据消耗时间占比。
NetIOSizePercentFloat30.11数据在不同节点间网络传输的数据量占比。
NetIOTimePercentFloat11.11数据在不同节点间网络传输消耗的时间占比。
Children算子结构体递归结构子节点算子,字段结构与父节点算子结构一致,最下层子节点的该值为空。

示例

正常返回示例

JSON格式

{
  "RequestId": "425AAA6A-63E0-1929-A1CE-3D9036CBC463",
  "QueryID": "71403480878****",
  "SessionID": "658****",
  "StartTime": 1660719602199,
  "Duration": 16,
  "SQLStmt": "select n_live_tup, n_live_tup + n_dead_tup, pg_relation_size(table_name), last_vacuum from pg_stat_user_tables where relid = table_name::regclass",
  "User": "adbpguser",
  "Database": "adbtest",
  "Status": "finished",
  "QueryPlan": "{\\\"children\\\":********\\\"startTime\\\":1660719602199}",
  "TextPlan": "******",
  "SortedMetrics": "{\\\"costSort\\\":******:\\\"Seq Scan-9\\\",\\\"value\\\":0.0}]}",
  "MaxOutputRows": "10"
}

错误码

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

变更历史

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