# 开启全量SQL或修改默认配置 - EnablingSQLExplorerorModifyingDefaultConfigurations #### 功能介绍 开启全量SQL功能。使实例Agent侧开启内核侧全量SQL能力，持续化采集GaussDB数据库实例上的执行SQL语句，定时批量持久化存储于LTS云服务对应日志流中。 - 调用接口前，您需要了解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=StartFullSql)中调试该接口。 #### 前提条件 - 管控平台已对接凭证托管服务(CCMS)。 - 管控平台已接入LTS云日志服务，并使用CCMS托管。 - 用户账号具备LTS日志组/流操作和日志分析功能权限。 #### URI POST /v3/{project_id}/instances/{instance_id}/full-sqls/start 表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参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | storage_mode | 是 | String | **参数解释：** 存储类型。 **约束限制：** 公有云场景，只支持LTS云日志服务存储。 **取值范围：** LTS：LTS云日志服务。 **默认取值** **：** 不涉及。 | | is_exclude_sys_user | 否 | Boolean | **参数解释：** 是否过滤系统用户。 **约束限制：** 不涉及。 **取值范围：** - true：过滤系统用户。 - false：不过滤系统用户。 **默认取值** **：** false。 | | save_days | 是 | Integer | **参数解释：** 全量SQL采集数据最大保留天数。单位：天。 **约束限制：** 不涉及。 **取值范围：** \[1, 30\] **默认取值** **：** 不涉及。 | | lts_config | 是 | Object | **参数解释** **：** LTS对接配置信息。 详情请参见[表4]。 **约束限制：** 不涉及。 | | sql_type_range | 否 | Array | **参数解释** **：** SQL采集类型列表。默认取值\[\]，表示采集所有SQL语句。 详情请参见[表5]。 **约束限制：** 不涉及。 | 表4LtsConfig | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | log_group_name | 是 | String | **参数解释：** LTS日志组名称。 **约束限制：** 满足正则匹配表达式校验：\^GROUP_GAUSSDB_APS-\[a-zA-Z0-9-_\]{32}in(14\|20)$。 **取值范围：** 通常为GROUP_GAUSSDB_APS-实例ID。 **默认取值** **：** 不涉及。 | | log_stream_name | 是 | String | **参数解释：** LTS日志流名称。 **约束限制：** 满足正则匹配表达式校验：\^STREAM_APS_FULL_SQL-\[a-zA-Z0-9-_\]{32}in(14\|20)$。 **取值范围：** 通常为STREAM_APS_FULL_SQL-实例ID。 **默认取值** **：** 不涉及。 | 表5SqlTypeRange | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | category | 是 | String | **参数解释：** SQL类型的归类名称。 **约束限制：** - 对常用SQL类型，简单归类为6个类别，每个类别对应一组固定的采集SQL语句类型列表，采用前缀进行匹配。 - 对于其他场景，可以使用自定义类别，允许按需自定义采集SQL的语句前缀。 **取值范围：** - all：不区分SQL类型，全部采集。 - ddl：只采集DDL语句类别，包含如下SQL语句类型： create, alter, drop, truncate, reindex, vacuum, analyze, declare, move, close。 - dml：只采集DML语句类型，包含如下SQL语句类型： insert, update, delete, merge, show, explain, prepare, lock, copy, execute, deallocate。 - dcl：只采集DCL语句类型，包含如下SQL语句类型： grant, revoke, reassign, set。 - tcl：只采集TCL语句类型，包含如下SQL语句类型： begin, commit, rollback, start, savepoint, checkpoint, release savepoint。 - dql：只采集DQL语句类型，包含如下SQL语句类型： select。 - custom：采集自定义语句类型。需在prefixes字段中，填写要采集的SQL语句前缀片段。 **默认取值** **：** 不涉及。 | | prefixes | 否 | Array of String | **参数解释：** 针对custom自定义类别，指定要采集的SQL语句类型的列表，默认取值为\[\]。采集过程中，采用前缀方式对SQL文本进行匹配。 **约束限制：** - category取值custom时，此参数必填，不可为空。 - category取值其他类别时，此参数忽略。 | #### 响应参数 表6响应Body参数 | **参数** | **参数类型** | **描述** | |:---|:---|:---| | job_id | String | **参数解释** **：** 任务ID。 **取值范围** **：** 不涉及。 | #### 请求示例 开启全量SQL。 ``` POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/4a89780fa1024361bcb855fed6aab89e/instances/cf9c879513144362bce2b3760ed81d3bin14/full-sqls/start { "storage_mode": "LTS", "is_exclude_sys_user": false, "lts_config": { "log_group_name": "GROUP_GAUSSDB_APS-cf9c879513144362bce2b3760ed81d3bin14", "log_stream_name": "STREAM_APS_FULL_SQL-cf9c879513144362bce2b3760ed81d3bin14" }, "sql_type_range": [{ "category": "dml" }, { "category": "dql" } ], "save_days": 30 } ``` #### 响应示例 ``` { "job_id":"8fd390dc-3be5-430d-8952-9cc0a75647a1" } ``` #### 状态码 - 正常 202 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。