文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ Top SQL/ 导出Top SQL列表 - ExportingTopSQLStatements
更新时间：2025-12-25 GMT+08:00
查看PDF
分享

导出Top SQL列表 - ExportingTopSQLStatements

功能介绍

导出Top SQL列表。

接口约束

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

调试

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

URI

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

表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 objects

参数解释：

字段汇聚查询条件列表。

详情请参见表4。

约束限制：

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

参数

是否必选

参数类型

描述

name

是

String

参数解释：

查询字段名称。

约束限制：

只支持字符串"query"。

取值范围：

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

默认取值：

不涉及。

condition

是

String

参数解释：

合并条件。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

values

是

Array of strings

参数解释：

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

约束限制：

不涉及。

is_fuzzy

否

Boolean

参数解释：

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

约束限制：

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

取值范围：

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

默认取值：

true

响应参数

无。

请求示例

POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/top-sql-list/export
{
  "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"
      ]
    }
  ]
}

响应示例

无。

状态码

错误码

请参见错误码。

父主题： Top SQL

相关文档