# 查询全量SQL开关记录 - QueryingSQLExplorerStatusRecords #### 功能介绍 查询全量SQL开关记录列表。 - 调用接口前，您需要了解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=ListFullSqlSwitches)中调试该接口。 #### URI GET /v3/{project_id}/instances/{instance_id}/full-sql-switches 表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请求Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | **参数解释：** 索引位置，偏移量。 **约束限制：** 不涉及。 **取值范围：** 0 \~ 2,147,483,647。 **默认取值** **：** 默认为0（偏移0条数据，表示从第一条数据开始查询）。 | | limit | 否 | Integer | **参数解释：** 查询记录数。 **约束限制：** 不涉及。 **取值范围：** 1\~1000。 **默认取值** **：** 默认为100。 | #### 请求参数 表3请求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** | #### 响应参数 表4响应Body参数 | **参数** | **参数类型** | **描述** | |:---|:---|:---| | total_count | Integer | **参数解释** **：** 总记录数量。 **取值范围** **：** 不涉及。 | | full_sql_switches | Array | **参数解释** **：** 开关记录列表。 详情请参见[表5]。 | | allowed_sql_types | Array | **参数解释** **：** 可选择的SQL采集类别清单列表。供开启全量SQL时做配置下发参考。 详情请参见[表7]。 | 表5FullSqlSwitch | **参数** | **参数类型** | **描述** | |:---|:---|:---| | is_open | Boolean | **参数解释** **：** 是否开启全量SQL。 **取值范围** **：** - true：已开启。 - false：已关闭。 | | begin_time | String | **参数解释** **：** 开关状态持续的开始时间。格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量。 **取值范围** **：** 不涉及。 | | end_time | String | **参数解释** **：** 开关状态持续的结束时间。格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量。 **取值范围** **：** 为null则表示，开关状态还在持续，没有发生切换。 | | save_days | Integer | **参数解释** **：** 已采集的全量SQL数据的最大保留天数。单位：天。 **取值范围** **：** \[1,30\] | | storage_mode | String | **参数解释** **：** 全量SQL数据存储类型。 **取值范围** **：** LTS：LTS云日志服务。 | | is_exclude_sys_user | Boolean | **参数解释：** 是否过滤系统用户。 **取值范围：** - true：过滤系统用户。 - false：不过滤系统用户。 | | lts_config | Object | **参数解释** **：** LTS对接配置信息。详情请参见[表6]。 | | sql_type_range | Array | **参数解释** **：** SQL采集类型列表。详情请参见[表7]。 | 表6LtsConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | group_ttl_in_days | Integer | **参数解释：** LTS日志组中数据最大保留天数。单位：天。 **取值范围：** \[1,30\] | | group_log_type | String | **参数解释：** LTS日志组类别。 **取值范围：** 通常为aps_log，标识为智能运维专用日志组。 | | log_group_name | String | **参数解释：** LTS日志组名称。 **取值范围：** 通常为GROUP_GAUSSDB_APS-实例ID。 | | log_group_id | String | **参数解释：** LTS日志组ID。 **取值范围：** 不涉及。 | | log_stream_name | String | **参数解释：** LTS日志流名称。 **取值范围：** 通常为STREAM_APS_FULL_SQL-实例ID。 | | log_stream_id | String | **参数解释：** LTS日志流ID。 **取值范围：** 不涉及。 | | stream_log_type | String | **参数解释：** LTS日志流类别。 **取值范围：** 通常为full_sql，标识为全量SQL专用日志流。 | | stream_ttl_in_days | Integer | **参数解释：** LTS日志流中数据最大保留天数。单位：天。 **取值范围：** \[1,30\] | | stream_structure_config_id | String | **参数解释：** LTS日志流结构化配置ID。 **取值范围：** 不涉及。 | | stream_index_config_id | String | **参数解释：** LTS日志流索引配置ID。 **取值范围：** 不涉及。 | 表7SqlTypeRangeConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | category | String | **参数解释：** SQL类型的归类名称。 - 对常用SQL类型，简单归类为6个类别，每个类别对应一组固定的采集SQL语句类型列表，采用前缀进行匹配。 - 对于其他场景，可以使用自定义类别，允许按需自定义采集SQL的语句前缀。 **取值范围：** - all：不区分SQL类型，全部采集。 - ddl：只采集DDL语句类型。 - dml：只采集DML语句类型。 - dcl：只采集DCL语句类型。 - tcl：只采集TCL语句类型。 - dql：只采集DQL语句类型。 - custom：采集自定义语句类型。 | | prefixes | Array of String | **参数解释：** 对应SQL类别中，采集的SQL语句类型列表，采用前缀方式进行匹配。 对应不同的SQL类别，取值有所不同，对应关系如下： - all：不区分SQL类型，全部采集。对应取值为： \[".\*"\]。 - ddl：只采集DDL语句类别，对于取值为： \["create", "alter", "drop", "truncate", "reindex", "vacuum", "analyze", "declare", "move", "close"\]。 - dml：只采集DML语句类型，对于取值为： \["insert", "update", "delete", "merge", "show", "explain", "prepare", "lock", "copy", "execute", "deallocate"\]。 - dcl：只采集DCL语句类型，对于取值为： \["grant", "revoke", "reassign", "set"\]。 - tcl：只采集TCL语句类型，对于取值为： \["begin", "commit", "rollback", "start", "savepoint", "checkpoint", "release savepoint"\]。 - dql：只采集DQL语句类型，对于取值为： \["select"\]。 - custom：采集自定义语句类型。对应取值为： 开启全量SQL时，用户填写的自定义SQL语句类型列表。 **取值范围：** 不涉及。 | | is_preset | Boolean | **参数解释：** 对应SQL类别是否为预置类别。 **取值范围：** - true：对应category取值all、ddl 、dml 、dcl 、tcl 、dql 。 - false：对应category取值custom。 | #### 请求示例 查询全量SQL开关记录列表。 ``` GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/4a89780fa1024361bcb855fed6aab89e/instances/0abd10ac1d3e4ab5a56330c304e7da5fin14/full-sql-switches?limit=1000&offset=0 ``` #### 响应示例 ``` { "total_count": 1, "allowed_sql_types": [ { "category": "all", "prefixes": [ ".*" ], "is_preset": true }, { "category": "dml", "prefixes": [ "insert", "update", "delete", "merge", "show", "explain", "prepare", "lock", "copy", "execute", "deallocate" ], "is_preset": true }, { "category": "custom", "prefixes": [], "is_preset": false }, { "category": "dcl", "prefixes": [ "grant", "revoke", "reassign", "set" ], "is_preset": true }, { "category": "tcl", "prefixes": [ "begin", "commit", "rollback", "start", "savepoint", "checkpoint", "release savepoint" ], "is_preset": true }, { "category": "ddl", "prefixes": [ "create", "alter", "drop", "truncate", "reindex", "vacuum", "analyze", "declare", "move", "close" ], "is_preset": true }, { "category": "dql", "prefixes": [ "select" ], "is_preset": true } ], "full_sql_switches": [ { "is_open": true, "begin_time": "2025-08-06T16:40:39+0800", "end_time": null, "save_days": 30, "storage_mode": "LTS", "lts_config": { "log_group_name": "GROUP_GAUSSDB_APS-0abd10ac1d3e4ab5a56330c304e7da5fin14", "log_group_id": "a137d930-fa2a-4a7b-9cec-f50e3d69260f", "group_log_type": "aps_log", "group_ttl_in_days": 30, "log_stream_name": "STREAM_APS_FULL_SQL-0abd10ac1d3e4ab5a56330c304e7da5fin14", "log_stream_id": "f418b717-9587-4ab2-9c33-56fad6b55ca9", "stream_log_type": "full_sql", "stream_ttl_in_days": 30, "stream_structure_config_id": "4a89780fa1024361bcb855fed6aab89e_a137d930-fa2a-4a7b-9cec-f50e3d69260f_f418b717-9587-4ab2-9c33-56fad6b55ca9", "stream_index_config_id": "f418b717-9587-4ab2-9c33-56fad6b55ca9" }, "sql_type_range": [ { "category": "all", "prefixes": [ ".*" ], "is_preset": true } ], "is_exclude_sys_user": false } ] } ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。