DescribeDiagnosisSQLInfo_云原生数据仓库 AnalyticDB PostgreSQL版_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

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

流控信息

请求速率为3000/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
gpdb:DescribeDiagnosisSQLInfo
Get
DBInstance
acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

请求参数

字段名称字段详情
DBInstanceIdstring

实例 ID。展开详情

示例值:gp-bp12ga6v69h86****参考取值来源:
    UpgradeDBInstance
    CreateDBInstance
    UpdateDBInstancePlan
    DescribeDBInstances
    PauseInstance
    ModifyDBInstancePayType
    ResumeInstance
    UploadDocumentAsync
    DownloadDiagnosisRecords
    UnloadSampleData
QueryIDstring

查询 ID,即查询的唯一标识。展开详情

示例值:71403480878****
Databasestring

数据库名称。

示例值:adbtest

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:425AAA6A-63E0-1929-A1CE-3D9036CBC463
QueryIDstring

查询 ID。

示例值:71403480878****
SessionIDstring

查询所属的会话 ID。

示例值:658****
StartTimeinteger<int64>

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

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:1660719602199
Durationinteger<int32>

查询运行的总时间,单位为秒(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 执行状态,取值说明:展开详情

示例值: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算子结构体递归结构子节点算子,字段结构与父节点算子结构一致,最下层子节点的该值为空。

返回示例

变更历史

变更时间变更内容概要操作
2022-06-22
新增OpenAPI,查看SQL语句的详细信息

相关示例

获取存储弹性模式或Serverless类型的AnalyticDB PostgreSQL实例某个查询SQL的详情
2022-06-30