更新时间:2025-09-11 GMT+08:00
分享

查询Top SQL列表

功能介绍

根据实例ID查询Top SQL信息。

接口约束

仅支持包含有CN或DN(主、备)组件的节点。

调试

您可以在API Explorer中调试该接口。

URI

POST /v3/{project_id}/instances/{instance_id}/top-sql-list

表1 参数说明

名称

是否必选

说明

project_id

参数解释:

租户在某一Region下的项目ID。

获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_id

参数解释:

实例ID,此参数是用户创建实例的唯一标识。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为36个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制:

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释:

语言。

约束限制:

不涉及。

取值范围

  • zh-cn
  • en-us

默认取值

en-us

表3 请求Body参数

参数

是否必选

参数类型

描述

instance_id

String

参数解释:

实例ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

node_ids

Array of strings

参数解释:

所选实例节点ID列表。

约束限制:

不涉及。

start_time

Long

参数解释:

起始时间。

约束限制:

13位UNIX时间戳格式,单位是毫秒,时区是UTC。

取值范围:

不涉及。

默认取值

不涉及。

end_time

Long

参数解释:

结束时间。

约束限制:

13位UNIX时间戳格式,单位是毫秒,时区是UTC。

取值范围:

不涉及。

默认取值

不涉及。

start_time_utc

String

参数解释:

起始时间。

约束限制:

UTC时间。

取值范围:

不涉及。

默认取值

不涉及。

end_time_utc

String

参数解释:

结束时间。

约束限制:

UTC时间。

取值范围:

不涉及。

默认取值

不涉及。

support_system

Boolean

参数解释:

是否支持展示系统用户。

约束限制:

不涉及

取值范围:

  • true:支持展示系统用户。
  • false:不支持展示系统用户。

默认取值

不涉及。

sql_id

String

参数解释:

Top SQL的归一化SQL ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

db_name

String

参数解释:

Top SQL的数据库名。

约束限制:

引擎版本8.200及以上显示。

取值范围:

不涉及。

默认取值

不涉及。

user_name

String

参数解释:

Top SQL的用户名。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

sql_text

String

参数解释:

Top SQL的SQL文本。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

multi_queries

Array of MultiMergeCondition

参数解释

字段汇聚查询条件列表。

详情请参见表4

约束限制:

只支持针对query字段全与或者全或的查询。

表4 MultiMergeCondition

参数

参数类型

描述

name

String

参数解释

查询字段名称。

约束限制:

只支持字符串"query"。

取值范围:

由英文字母(大小写)、数字或下划线组成,长度为 1 至 128 个字符。

默认取值

不涉及。

condition

String

参数解释

合并条件。

约束限制:

不涉及。

取值范围:

仅限字符串:"and"、"or"、"AND"、"OR"。

默认取值

不涉及。

values

Array of strings

参数解释

多个过滤检索条件内容集合。由 1 至 5 个字符串组成的列表。

约束限制:

不涉及。

isFuzzy

Boolean

参数解释

多个过滤检索条件内容集合。

约束限制:

只支持为true进行模糊查询。

取值范围:

  • true 表示模糊查询。
  • false 表示精确匹配。

默认取值

true

响应参数

表5 响应Body参数

参数

参数类型

描述

top_sql_infos

Array of objects

参数解释:

Top SQL信息列表。详细内容请参见表6

total

Integer

参数解释:

Top SQL总条数。

取值范围:

不涉及。

表6 TopSqlInfo

参数

参数类型

描述

sql_id

String

参数解释:

Top SQL的归一化SQL ID。

取值范围:

不涉及。

user_name

String

参数解释:

Top SQL的用户名。

取值范围:

不涉及。

sql_text

String

参数解释:

Top SQL的SQL文本。

取值范围:

不涉及。

calls_percent

String

参数解释:

Top SQL的调用频率占比。

取值范围:

0-100。

cpu_percent

String

参数解释:

Top SQL的CPU开销占比。

取值范围:

0-100。

io_percent

String

参数解释:

Top SQL的IO开销占比。

取值范围:

0-100。

calls

String

参数解释:

Top SQL的调用次数。

取值范围:

大于等于0。

returned_rows

String

参数解释:

Top SQL的返回元祖数。

取值范围:

大于等于0。

tuple_read

String

参数解释:

Top SQL的读取元组数。

取值范围:

大于等于0。

avg_elapse_time

String

参数解释:

Top SQL的平均时间开销。单位ms。

取值范围:

大于等于0。

total_elapse_time

String

参数解释:

Top SQL的总时间开销。单位ms。

取值范围:

大于等于0。

cpu_time

String

参数解释:

Top SQL的CPU开销。单位ms。

取值范围:

不涉及。

io_time

String

参数解释:

Top SQL的IO开销。单位ms。

取值范围:

不涉及。

min_elapse_time

String

参数解释:

Top SQL的最小执行时间。单位ms。

取值范围:

不涉及。

max_elapse_time

String

参数解释:

Top SQL的最大执行时间。单位ms。

取值范围:

不涉及。

sql_hit_ratio

String

参数解释:

Top SQL的SQL命中率。

取值范围:

大于等于0。

node_id

String

参数解释:

Top SQL的节点ID。

取值范围:

不涉及。

node_name

String

参数解释:

Top SQL的节点名称。

取值范围:

不涉及。

db_name

String

参数解释:

Top SQL的数据库名(引擎版本8.200及以上支持)。

取值范围:

不涉及。

请求示例

查询Top SQL列表信息。

POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/top-sql-list
{
  "instance_id": "3d39c18788b54a919bab633874c159dfin14",
  "node_ids": [
    "ce86fdea77304bfb9469d0b75ea3943ano14"
  ],
  "start_time": 1745477837000,
  "end_time": 1745564237000,
  "start_time_utc": "2025-04-24T06:57:17+0000",
  "end_time_utc": "2025-04-25T06:57:17+0000",
  "user_name": "dbmind_server",
  "sql_text": "BEGIN",
  "sql_id": "1872435845",
  "db_name": "postgres",
  "support_system": false,
  "multi_queries": [
    {
      "name": "query",
      "condition": "AND",
      "is_fuzzy": true,
      "values": [
        "BEGIN"
      ]
    }
  ]
}

响应示例

查询慢SQL节点信息成功。
{
    "top_sql_infos": [
        {
            "sql_id": "1872435845",
            "user_name": "dbmind_server",
            "sql_text": "BEGIN",
            "calls_percent": "48.15",
            "cpu_percent": "20.16",
            "io_percent": "0.00",
            "calls": "117",
            "returned_rows": "0",
            "tuple_read": "0",
            "avg_elapse_time": "0.0520",
            "total_elapse_time": "6.0830",
            "cpu_time": "9.2660",
            "io_time": "0.0000",
            "min_elapse_time": "0.0210",
            "max_elapse_time": "0.1820",
            "sql_hit_ratio": "0",
            "node_id": "ce86fdea77304bfb9469d0b75ea3943ano14",
            "node_name": "gauss-6e34-gaussdbv5cn_0",
            "db_name": "postgres"
        },
    "total": 1
}

状态码

错误码

请参见错误码

相关文档