# 查询实例全量SQL聚合统计列表 - QueryingFullSQLStatisticsofanInstance #### 功能介绍 查询GaussDB数据库实例全量SQL聚合统计列表，主要统计各唯一SQL ID下的SQL记录总数量以及相关时间指标的平均值。支持增强型条件过滤， 如可以对SQL文本（query字段）进行多条件合并查询，对total_sql_time、sql_count字段进行大于、小于、区间范围等条件的过滤。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=ListEnhanceFullSqlStatistics)中调试该接口。 #### URI POST /v3/{project_id}/instances/{instance_id}/list-full-sql-statistics 表1参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释：** 实例ID，此参数是用户创建实例的唯一标识。请参考[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)接口获取实例ID。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 **默认取值** **：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围** **：** - **zh-cn：**中文 - **en-us** **：**英文 **默认取值** **：** **en-us** | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | node_id | 否 | String | **参数解释：** 节点ID。获取方式请参考[查询实例的组件列表 - QueryingtheComponentsofaDBInstance](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_028.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | component_id | 否 | String | **参数解释：** 组件ID。获取方式请参考[查询实例的组件列表 - QueryingtheComponentsofaDBInstance](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_028.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | 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列表 - QueryingFullDatabySQLStatement](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_541.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | sql_exec_id | 否 | String | **参数解释：** 唯一SQL ID。获取方式请参考[查询全量单条SQL列表 - QueryingFullDatabySQLStatement](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_541.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | transaction_id | 否 | String | **参数解释：** 事务ID。获取方式请参考[查询全量单条SQL列表 - QueryingFullDatabySQLStatement](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_541.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | trace_id | 否 | String | **参数解释：** 链路ID。获取方式请参考[查询全量单条SQL列表 - QueryingFullDatabySQLStatement](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_541.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | db_name | 否 | String | **参数解释：** 数据库名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | schema_name | 否 | String | **参数解释：** schema名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | username | 否 | String | **参数解释：** 用户名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | client_addr | 否 | String | **参数解释：** 客户端地址。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | client_port | 否 | String | **参数解释：** 客户端端口。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | order_by | 否 | String | **参数解释：** 排序字段。 **约束限制：** 不涉及。 **取值范围：** - sql_id：归一化SQL ID。 - sql_count：汇总SQL条目数。 - avg_db_time：平均有效DB耗时。 - avg_cpu_time：平均CPU执行耗时。 - avg_execution_time：平均SQL执行器内执行时间。 - avg_data_io_time：平均IO耗时。 - start_time_stamp：开始时间。 **默认取值** **：** sql_count。 | | is_slow_sql | 否 | Boolean | **参数解释：** 是否为慢SQL。 **约束限制：** 不涉及。 **取值范围：** - true：是慢SQL。 - false：不是慢SQL。 **默认取值** **：** 不涉及。 | | order | 否 | String | **参数解释：** 排序方式，支持升序和降序。 **约束限制：** 不涉及。 **取值范围：** - DESC 降序。 - ASC 升序。 **默认取值** **：** DESC。 | | application_name | 否 | String | **参数解释：** 应用名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | multi_queries | 否 | Array | **参数解释** **：** 字段汇聚查询条件列表。 详情请参见[表4]。 **约束限制：** 只支持针对query字段全与或者全或的查询。 | | compare_conditions | 否 | Array | **参数解释：** 组合比较查询条件，可针对某个给定过滤字段，进行区间范围、大小、小于等条件合并查询。详情请参见[表5]。 **约束限制：** 不涉及。 | | limit | 否 | Long | **参数解释：** 查询记录数。例如该参数设定为10，则查询结果最多只显示10条记录。 **约束限制：** 不涉及。 **取值范围：** \[1, 1000\] **默认取值**： 默认为10。 | | offset | 否 | Long | **参数解释：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。例如：该参数指定为0，limit指定为10，则只展示第1\~10条数据。 **约束限制：** 不涉及。 **取值范围：** \[0, 9223372036854774807\] **默认取值**： 默认为0（偏移0条数据，表示从第一条数据开始查询）。 | 表4MultiMergeCondition | **参数** | 是否必选 | **参数类型** | **描述** | |:---|:---|:---|:---| | name | 是 | String | **参数解释** **：** 查询字段名称。 **约束限制：** 只支持字符串"query"。 **取值范围：** "query"：表示查询。 **默认取值** **：** 不涉及。 | | condition | 是 | String | **参数解释** **：** 合并条件。多个筛选条件之间的逻辑合并方式。当查询涉及多个筛选条件时，通过该参数指定条件之间是"且"还是"或"的关系。 **约束限制：** 不涉及。 **取值范围：** - "and"："与"。 - "or"："或"。 - "AND"："与"。 - "OR"："或"。 **默认取值** **：** 不涉及。 | | values | 是 | Array of strings | **参数解释** **：** 多个过滤检索条件内容集合。每个字符串为一个SQL文本查询条件，用于对query字段进行模糊匹配。 **约束限制：** 由 1 至 5 个字符串组成的列表。 | | is_fuzzy | 否 | Boolean | **参数解释** **：** 是否进行模糊查询。 **约束限制：** 只支持为true进行模糊查询。 **取值范围：** - true 表示模糊查询。 - false 表示精确匹配。 **默认取值** **：** true | 表5CompareCondition | **参数** | 是否必选 | **参数类型** | **描述** | |:---|:---|:---|:---| | name | 是 | String | **参数解释**： 查询字段名称，当前仅支持特定的数值字段。 **约束限制：** 不涉及。 **取值范围**： - total_sql_time：总SQL耗时（微秒）。 - sql_count：执行次数。 **默认取值** **：** 不涉及。 | | 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参数 | **参数** | **参数类型** | **描述** | |:---|:---|:---| | statistics | Array of objects | **参数解释**： 全量SQL聚合统计列表。详情请参见[表7]。 | | total_count | Integer | **参数解释**： 全量SQL聚合统计列表总数。 **取值范围**： 不涉及。 | 表7FullSqlStatistics | **参数** | **参数类型** | **描述** | |:---|:---|:---| | template | String | **参数解释**： SQL模板。未开启实例内核GUC参数（track_stmt_parameter）时，展示的是归一化SQL模板内容；开启该参数后，展示的是随机一条SQL记录中截断参数列表后的内容。 **取值范围**： 不涉及。 | | sql_id | String | **参数解释**： 归一化SQL ID。 **取值范围**： 不涉及。 | | sql_count | Long | **参数解释**： 汇总SQL条目数。 **取值范围**： 不涉及。 | | total_sql_time | Long | **参数解释**： 总SQL耗时（微秒）。 **取值范围**： 不涉及。 | | avg_sql_time | Long | **参数解释**： 平均SQL耗时（微秒）。 **取值范围**： 不涉及。 | | total_db_time | Long | **参数解释**： 总有效DB耗时（微秒）。 **取值范围**： 不涉及。 | | avg_db_time | Long | **参数解释**： 平均有效DB耗时（微秒）。 **取值范围**： 不涉及。 | | total_cpu_time | Long | **参数解释**： 总CPU耗时（微秒）。 **取值范围**： 不涉及。 | | avg_cpu_time | Long | **参数解释**： 平均CPU执行耗时（微秒）。 **取值范围**： 不涉及。 | | avg_execution_time | Long | **参数解释**： 平均SQL执行器内执行时间（微秒）。 **取值范围**： 不涉及。 | | avg_parse_time | Long | **参数解释**： 平均解释器时间（微秒）。 **取值范围**： 不涉及。 | | avg_plan_time | Long | **参数解释**： 平均执行计划时间（微秒）。 **取值范围**： 不涉及。 | | total_data_io_time | Long | **参数解释**： 总IO耗时（微秒）。 **取值范围**： 不涉及。 | | avg_data_io_time | Long | **参数解释**： 平均IO耗时（微秒）。 **取值范围**： 不涉及。 | | avg_n_blocks_hit | Long | **参数解释**： 平均Buffer块命中次数。 **取值范围**： 不涉及。 | | avg_n_returned_rows | Long | **参数解释**： 平均返回行数。 **取值范围**： 不涉及。 | | avg_n_tuples_fetched | Long | **参数解释**： 平均扫描行数。 **取值范围**： 不涉及。 | | start_time_stamp | Long | **参数解释**： 开始时间戳（毫秒）。 **取值范围**： 不涉及。 | | end_time_stamp | Long | **参数解释**： 结束时间戳（毫秒）。 **取值范围**： 不涉及。 | #### 请求示例 查询全量SQL统计列表。 ``` POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/4a89780fa1024361bcb855fed6aab89e/instances/3d39c18788b54a919bab633874c159dfin01/list-full-sql-statistics { "offset": 0, "limit": 10, "begin_time": "2025-08-06T07:32:24+0000", "end_time": "2025-08-06T08:32:24+0000", "compare_conditions": [ { "name": "sql_count", "min": 1, "max": 100 }, { "name": "total_sql_time", "max": 1000 } ], "query": "select name $1 from table", "sql_exec_id": "72902018970165236", "transaction_id": "0", "trace_id": "d3eef567-4be6-424c-860f-75684457bf72", "order_by": "sql_count", "order": "DESC", "db_name": "postgres", "schema_name": "public", "username": "rdsAdmin", "node_id": "672cd018568d40b980ce7bf345ebd5a7no14", "component_id": "cn_5001", "application_name": "gsql", "is_slow_sql": true, "client_addr": "127.0.0.1", "client_port": "58958", "sql_id": "1790862420", "multi_queries": [ { "name": "query", "condition": "OR", "is_fuzzy": true, "values": [ "select" ] } ] } ``` #### 响应示例 ``` { "total_count": 1, "statistics": [ { "template": "SELECT pgxc_node_str(), phyrds, phywrts FROM dbe_perf.local_rel_iostat", "sql_id": "1790862420", "sql_count": 1, "total_sql_time": 489, "avg_sql_time": 489, "total_db_time": 489, "avg_db_time": 489, "total_cpu_time": null, "avg_cpu_time": null, "avg_execution_time": null, "avg_parse_time": null, "avg_plan_time": null, "total_data_io_time": null, "avg_data_io_time": null, "avg_n_blocks_hit": null, "avg_n_returned_rows": null, "avg_n_tuples_fetched": null, "start_time_stamp": 1754469124297, "end_time_stamp": 1754469124297 } ] } ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。