文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 全量SQL/ 查询全量单条SQL列表
更新时间：2025-10-21 GMT+08:00
查看PDF
分享

查询全量单条SQL列表

功能介绍

查询全量单条SQL记录列表。支持增强型条件过滤， 如可以对SQL文本（query字段）进行多条件合并查询，对db_time字段进行大于、小于、区间范围等条件的过滤。

调试

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

URI

POST /v3/{project_id}/instances/{instance_id}/list-full-sqls

表1 参数说明

名称

是否必选

参数类型

说明

project_id

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例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参数

参数

是否必选

参数类型

描述

node_id

否

String

参数解释：

节点ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

begin_time

是

String

参数解释：

查询开始时间。

约束限制：

ISO 8601 UTC格式。模式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量。

时区中的+号需要进行URL编码，编码为%2B，时区中的-号无需编码。

例如：北京时间偏移显示为+0800，begin_time=2024-03-15T17:20:33+0800，传参时编码为begin_time=2024-03-15T17:20:33%2B0800。

取值范围：

时间区间（begin_time ~ end_time）不能超过30天。

默认取值：

不涉及。

end_time

是

String

参数解释：

查询结束时间。

约束限制：

ISO 8601 UTC格式。模式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量。

时区中的+号需要进行URL编码，编码为%2B，时区中的-号无需编码。

例如：北京时间偏移显示为+0800，end_time=2024-03-16T17:20:33+0800，传参时编码为end_time=2024-03-16T17:20:33%2B0800。

取值范围：

时间区间（begin_time ~ end_time）不能超过30天。

默认取值：

不涉及。

query

否

String

参数解释：

SQL文本。

约束限制：

不涉及。

取值范围：

长度1-4096。

默认取值：

不涉及。

sql_id

否

String

参数解释：

归一化SQL ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

sql_exec_id

否

String

参数解释：

唯一SQL ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

transaction_id

否

String

参数解释：

事务ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

trace_id

否

String

参数解释：

链路ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

db_name

否

String

参数解释：

数据库名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

schema_name

否

String

参数解释：

schema名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

username

否

String

参数解释：

用户名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

client_addr

否

String

参数解释：

客户端地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

client_port

否

String

参数解释：

客户端端口。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

order_by

否

String

参数解释：

排序字段。

约束限制：

不涉及。

取值范围：

begin_time：起始时间。

默认取值：

begin_time

is_slow_sql

否

Boolean

参数解释：

是否为慢SQL。

约束限制：

不涉及。

取值范围：

  • true：是慢SQL。
  • false：不是慢SQL。

默认取值：

不涉及。

order

否

String

参数解释：

排序方式，支持升序和降序。

约束限制：

不涉及。

取值范围：

  • DESC：降序。
  • desc：降序。
  • ASC：升序。
  • asc：升序。

默认取值：

DESC

multi_queries

否

Array of MultiMergeCondition

参数解释：

字段汇聚查询条件列表。默认取值为[]。

详情请参见表4 MultiMergeCondition。

约束限制：

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

compare_conditions

否

Array of CompareCondition

参数解释：

组合比较查询条件，可针对某个给定过滤字段，进行区间范围、大小、小于等条件合并查询。默认取值为[]。详情请参见表5 CompareCondition。

约束限制：

不涉及。

limit

否

Long

参数解释：

最大查询记录数。例如该参数设定为10，则查询结果最多只显示10条记录。

约束限制：

对于公有云25.5.0.1及以上版本，此参数弃用，请勿传值。通过系统系统参数控制最大返回记录数量，默认为200。

取值范围：

[1, 1000]

默认取值：

默认为10。
表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
表5 CompareCondition

参数

是否必选

参数类型

描述

name

是

String

参数解释：

查询字段名称，当前仅支持特定的数值字段。

约束限制：

不涉及。

取值范围：

  • db_time：有效DB时间。
  • cpu_time：CPU耗时。
  • data_io_time：IO耗时。
  • execution_time：执行器内耗时。

默认取值：

不涉及。

enable_equal

否

Boolean

参数解释：

是否使能包含等于，如果为true，则表示包含边界条件（min或max）的取值。

约束限制：

不涉及。

取值范围：

  • true：包含区间边界。
  • false：不包含区间边界。

默认取值：

true

min

否

Long

参数解释：

最小值判断条件对应取值（大于条件）。

约束限制：

不涉及。

取值范围：

[0, 2^63-1]

默认取值：

不涉及。

max

否

Long

参数解释：

最大值判断条件对应取值（小于条件）。

约束限制：

不涉及。

取值范围：

[0, 2^63-1]

默认取值：

不涉及。

value

否

Long

参数解释：

等值判断条件对应取值（等于条件）。value的优先级最高，如果value不为空，则忽略min和max的取值设置；value为空时，才使能min和max的条件过滤。

约束限制：

不涉及。

取值范围：

[0, 2^63-1]

默认取值：

不涉及。

响应参数

表6 响应Body参数

参数

参数类型

描述

total_count

Integer

参数解释：

总记录数量。

取值范围：

不涉及。

limit_count

Integer

参数解释：

最大查询记录数量。主要供前端交互控制使用。

取值范围：

不涉及。

full_sqls

Array of FullSqlRecord

参数解释：

单条SQL记录列表。

详情请参见表7 FullSqlRecord。

parser

String

参数解释：

保留字，公有云不涉及，请忽略。

取值范围：

不涉及。

cursor_time

String

参数解释：

保留字，公有云不涉及，请忽略。

取值范围：

不涉及。
表7 FullSqlRecord

参数

参数类型

描述

id

String

参数解释：

SQL记录唯一键ID。

取值范围：

不涉及。

instance_id

String

参数解释：

实例ID。

取值范围：

不涉及。

node_id

String

参数解释：

节点ID。

取值范围：

不涉及。

component_id

String

参数解释：

组件ID。

取值范围：

不涉及。

db_name

String

参数解释：

数据库名称。

取值范围：

不涉及。

schema_name

String

参数解释：

schema名称。

取值范围：

不涉及。

username

String

参数解释：

用户名称。

取值范围：

不涉及。

application_name

String

参数解释：

用户发起的请求的应用程序名称。

取值范围：

不涉及。

client_addr

String

参数解释：

用户发起的请求的客户端地址。

取值范围：

不涉及。

client_port

String

参数解释：

用户发起请求的客户端端口。

取值范围：

不涉及。

sql_id

String

参数解释：

归一化SQL ID，对应内核字段：unique_sql_id。

取值范围：

不涉及。

sql_exec_id

String

参数解释：

唯一SQL ID，对应内核字段：debug_query_id。

取值范围：

不涉及。

transaction_id

String

参数解释：

事务ID，对应内核字段：debug_query_id。

取值范围：

不涉及。

trace_id

String

参数解释：

链路ID。

取值范围：

不涉及。

query

String

参数解释：

归一化SQL。

取值范围：

不涉及。

sql

String

参数解释：

解析后的原始SQL文本。

取值范围：

开启track_stmt_parameter参数后，会把SQL文本中的变量替换成真实值，展示原始的SQL。对于track_stmt_parameter参数关闭时采集的SQL文本，无法获取到SQL参数变量的值，展示的内容为空。

begin_time

String

参数解释：

开始时间，格式为“yyyy-mm-ddThh:mm:ss.SSSSSZ”。

取值范围：

不涉及。

end_time

String

参数解释：

结束时间，格式为“yyyy-mm-ddThh:mm:ss.SSSSSZ”。

取值范围：

不涉及。

all_time

Long

参数解释：

执行总时间（单位：微秒）。

取值范围：

不涉及。

db_time

Long

参数解释：

有效DB时间（单位：微秒）。

取值范围：

不涉及。

cpu_time

Long

参数解释：

CPU时间（单位：微秒）。

取值范围：

不涉及。

data_io_time

Long

参数解释：

IO时间（单位：微秒）。

取值范围：

不涉及。

execution_time

Long

参数解释：

执行器内执行时间（单位：微秒）。

取值范围：

不涉及。

scan_lines

Long

参数解释：

扫描行。

取值范围：

不涉及。

insert_rows

Long

参数解释：

插入行。

取值范围：

不涉及。

update_rows

Long

参数解释：

更新行。

取值范围：

不涉及。

delete_rows

Long

参数解释：

删除行。

取值范围：

不涉及。

is_slow_sql

Boolean

参数解释：

是否慢SQL。

取值范围：

不涉及。

start_timestamp

Long

参数解释：

SQL开始时间。格式为13位标准时间戳，如1754647168354。

取值范围：

不涉及。

finish_timestamp

Long

参数解释：

SQL结束时间，格式为13位标准时间戳，如1754647168355。

取值范围：

不涉及。

hit_rate

Double

参数解释：

SQL命中率。

计划即将下线，请勿使用。

取值范围：

不涉及。

请求示例

查询全量单条SQL列表。

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/4a89780fa1024361bcb855fed6aab89e/instances/cf9c879513144362bce2b3760ed81d3bin14/list-full-sqls
{
    "begin_time": "2025-08-08T08:59:29+0000",
    "end_time": "2025-08-08T09:59:29+0000",
    "compare_conditions": [{
            "name": "db_time",
            "min": 474,
            "max": 475,
            "enable_equal": true
        }
    ],
    "multi_queries": [{
            "name": "query",
            "condition": "AND",
            "is_fuzzy": true,
            "values": ["select node_name", "from pg_catalog.pgxc_node"]
        }
    ]
}

响应示例

{
    "parser": null,
    "total_count": 4,
    "limit_count": 1000,
    "cursor_time": null,
    "full_sqls": [
        {
            "id": "f084ca811d62f93af3dff2d508a981bc",
            "instance_id": "cf9c879513144362bce2b3760ed81d3bin14",
            "node_id": "b470c6297bb24c258e3eccf8dcaaa3f0no14",
            "component_id": "cn_5001",
            "query": "select node_name from pg_catalog.pgxc_node where nodeis_central;",
            "sql": "",
            "sql_id": "67570929",
            "sql_exec_id": "72620543991485094",
            "transaction_id": "0",
            "trace_id": "",
            "db_name": "postgres",
            "schema_name": "\"$user\",public",
            "username": "rdsAdmin",
            "begin_time": "2025-08-08 09:59:28 +0000",
            "end_time": "2025-08-08 09:59:28 +0000",
            "all_time": 424,
            "db_time": 474,
            "cpu_time": 417,
            "data_io_time": 0,
            "execution_time": 16,
            "scan_lines": 0,
            "update_rows": 0,
            "insert_rows": 0,
            "delete_rows": 0,
            "application_name": "cm_agent",
            "client_addr": "127.0.0.1",
            "client_port": 51698,
            "is_slow_sql": false,
            "hit_rate": 1.0,
            "start_timestamp": 1754647168354,
            "finish_timestamp": 1754647168355
        },
        {
            "id": "3118514c31fa176d98e1503a24a048fd",
            "instance_id": "cf9c879513144362bce2b3760ed81d3bin14",
            "node_id": "b470c6297bb24c258e3eccf8dcaaa3f0no14",
            "component_id": "cn_5001",
            "query": "select node_name from pg_catalog.pgxc_node where nodeis_central;",
            "sql": "",
            "sql_id": "67570929",
            "sql_exec_id": "72620543991483793",
            "transaction_id": "0",
            "trace_id": "",
            "db_name": "postgres",
            "schema_name": "\"$user\",public",
            "username": "rdsAdmin",
            "begin_time": "2025-08-08 09:57:40 +0000",
            "end_time": "2025-08-08 09:57:40 +0000",
            "all_time": 418,
            "db_time": 474,
            "cpu_time": 414,
            "data_io_time": 0,
            "execution_time": 22,
            "scan_lines": 0,
            "update_rows": 0,
            "insert_rows": 0,
            "delete_rows": 0,
            "application_name": "cm_agent",
            "client_addr": "127.0.0.1",
            "client_port": 51698,
            "is_slow_sql": false,
            "hit_rate": 1.0,
            "start_timestamp": 1754647060067,
            "finish_timestamp": 1754647060067
        },
        {
            "id": "b39f4a4f1e082ee2cd92522596394219",
            "instance_id": "cf9c879513144362bce2b3760ed81d3bin14",
            "node_id": "b470c6297bb24c258e3eccf8dcaaa3f0no14",
            "component_id": "cn_5001",
            "query": "select node_name from pg_catalog.pgxc_node where nodeis_central;",
            "sql": "",
            "sql_id": "67570929",
            "sql_exec_id": "72620543991483600",
            "transaction_id": "0",
            "trace_id": "",
            "db_name": "postgres",
            "schema_name": "\"$user\",public",
            "username": "rdsAdmin",
            "begin_time": "2025-08-08 09:57:23 +0000",
            "end_time": "2025-08-08 09:57:23 +0000",
            "all_time": 405,
            "db_time": 474,
            "cpu_time": 415,
            "data_io_time": 0,
            "execution_time": 19,
            "scan_lines": 0,
            "update_rows": 0,
            "insert_rows": 0,
            "delete_rows": 0,
            "application_name": "cm_agent",
            "client_addr": "127.0.0.1",
            "client_port": 51698,
            "is_slow_sql": false,
            "hit_rate": 1.0,
            "start_timestamp": 1754647043025,
            "finish_timestamp": 1754647043026
        },
        {
            "id": "bca651bfa3628029cea483db1ab629e6",
            "instance_id": "cf9c879513144362bce2b3760ed81d3bin14",
            "node_id": "b470c6297bb24c258e3eccf8dcaaa3f0no14",
            "component_id": "cn_5001",
            "query": "select node_name from pg_catalog.pgxc_node where nodeis_central;",
            "sql": "",
            "sql_id": "67570929",
            "sql_exec_id": "72620543991483104",
            "transaction_id": "0",
            "trace_id": "",
            "db_name": "postgres",
            "schema_name": "\"$user\",public",
            "username": "rdsAdmin",
            "begin_time": "2025-08-08 09:56:42 +0000",
            "end_time": "2025-08-08 09:56:42 +0000",
            "all_time": 420,
            "db_time": 475,
            "cpu_time": 410,
            "data_io_time": 0,
            "execution_time": 19,
            "scan_lines": 0,
            "update_rows": 0,
            "insert_rows": 0,
            "delete_rows": 0,
            "application_name": "cm_agent",
            "client_addr": "127.0.0.1",
            "client_port": 51698,
            "is_slow_sql": false,
            "hit_rate": 1.0,
            "start_timestamp": 1754647002918,
            "finish_timestamp": 1754647002918
        }
    ]
}

状态码

错误码

请参见错误码。

父主题： 全量SQL