调用DescribeDiagnosisSQLInfo查看SQL语句的详细信息_云原生数据仓库 AnalyticDB PostgreSQL版(AnalyticDB for PostgreSQL)-阿里云帮助中心

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

接口说明

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

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
gpdb:DescribeDiagnosisSQLInfo	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。说明您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情，包括实例 ID。	gp-bp12ga6v69h86****
QueryID	string	是	查询 ID，即查询的唯一标识。说明您可以调用 DescribeDiagnosisRecords 接口获取查询 ID。	71403480878****
Database	string	是	数据库名称。	adbtest

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	425AAA6A-63E0-1929-A1CE-3D9036CBC463
QueryID	string	查询 ID。	71403480878****
SessionID	string	查询所属的会话 ID。	658****
StartTime	long	查询开始的时间，为毫秒级的 UNIX 时间戳。	1660719602199
Duration	integer	查询运行的总时间，单位为秒（s）。	16
SQLStmt	string	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
User	string	用户名。	adbpguser
Database	string	数据库名称。	adbtest
Status	string	SQL 执行状态，取值说明： running：执行中。 finished：执行完成。	finished
QueryPlan	string	算子信息。	{\"children\":********\"startTime\":1660719602199}
TextPlan	string	查询计划信息。	******
SortedMetrics	string	按照指标的排序结构。	{\"costSort\":******:\"Seq Scan-9\",\"value\":0.0}]}
MaxOutputRows	string	最大输出行数。	10

QueryPlan 参数说明如下：

名称	类型	示例值	描述
OpertorID	Integer	1	算子在查询执行计划中的 ID。
OperatorTypeID	integer	10	算子类型 ID。
OperatorType	String	AGG	算子类型。
OperatorName	String	AGG-1	算子名称。
NodeWidth	Integer	1	执行计划树中，节点在该层的水平位置，从 1 开始。
NodeDepth	Integer	2	执行计划树中，节点所处的深度，从 1 开始。
LevelWidth	Integer	1	执行计划树中，节点所在层的总宽度，从 1 开始。
MaxDepth	Integer	2	执行计划树的最大深度，该值仅 root 节点支持，从 1 开始。
OutputRows	Integer	10	算子执行过程中输出的数据行数。
InputRows	Integer	1000	算子执行过程中输入的数据行数。
Memory	Float	100	算子占用内存，单位为 KB。
StartTime	String	1652843003000	算子开始执行的时间。
EndTime	String	1652843003100	算子结束执行的时间。
Duration	Float	6	算子执行消耗的时间，单位为毫秒（ms）。
DiskReadSize	Float	55	算子从磁盘读取数据量，单位为 Byte。
DiskReadTime	Float	0.1	算子从磁盘读取数据消耗的时间，单位为毫秒（ms）。
NetIOSize	Float	3000	数据在不同节点间网络传输的数据量，单位为 Byte。
NetIOTime	Float	0.1	数据在不同节点间网络传输消耗的时间，单位为毫秒（ms）。
MemoryPercent	Float	20.11	算子使用内存占比。
DurationPercent	Float	16.11	算子执行消耗时间占比。
DiskReadSizePercent	Float	55.11	算子从磁盘读取数据量占比。
DiskReadTimePercent	Float	11.11	算子从磁盘读取数据消耗时间占比。
NetIOSizePercent	Float	30.11	数据在不同节点间网络传输的数据量占比。
NetIOTimePercent	Float	11.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"
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史