开启全量SQL或修改默认配置

project_id

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID，此参数是用户创建实例的唯一标识。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

语言。

约束限制：

不涉及。

取值范围：

• zh-cn
• en-us

默认取值：

en-us。

storage_mode

是

String

参数解释：

存储类型。

约束限制：

公有云场景，只支持LTS云日志服务存储。

取值范围：

LTS：LTS云日志服务。

默认取值：

不涉及。

is_exclude_sys_user

否

Boolean

参数解释：

是否过滤系统用户。

约束限制：

不涉及。

取值范围：

• true：过滤系统用户。
• false：不过滤系统用户。

默认取值：

false。

save_days

是

Integer

参数解释：

全量SQL采集数据最大保留天数。

约束限制：

不涉及。

取值范围：

[1, 30]

默认取值：

不涉及。

lts_config

是

Object of LtsConfig

参数解释：

LTS对接配置信息。

详情请参见表4。

约束限制：

不涉及。

sql_type_range

否

Array of SqlTypeRange

参数解释：

SQL采集类型列表。默认取值[]，表示采集所有SQL语句。

详情请参见表5。

约束限制：

不涉及。

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。

默认取值：

不涉及。

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取值其他类别时，此参数忽略。

job_id

String

参数解释：

任务ID。

取值范围：

不涉及。