Enabling SQL Explorer or Modifying Default Configurations

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value can contain 36 characters. Only letters and digits are allowed.

Default Value

N/A

X-Auth-Token

Yes

String

Definition

User token.

You can obtain the token by calling the IAM API used to obtain a user token.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Language.

Constraints

N/A

Range

• zh-cn
• en-us

Default Value

en-us

storage_mode

Yes

String

Definition

Storage type.

Constraints

In Huawei Cloud scenarios, only LTS can be used.

Range

LTS: Log Tank Service (LTS)

Default Value

N/A

is_exclude_sys_user

No

Boolean

Definition

Whether to exclude system users.

Constraints

N/A

Range

• true: System users are excluded.
• false: System users are not excluded.

Default Value

false

save_days

Yes

Integer

Definition

Maximum number of days for storing full SQL data collected.

Constraints

N/A

Range

[1, 30]

Default Value

N/A

lts_config

Yes

Object of LtsConfig

Definition

LTS interconnection configuration information.

For details, see Table 4.

Constraints

N/A

sql_type_range

No

Array of SqlTypeRange

Definition

Types of SQL statements to be collected. The default value is [], indicating that all SQL statements are collected.

For details, see Table 5.

Constraints

N/A

log_group_name

Yes

String

Definition

LTS log group name.

Constraints

The value must match the regular expression ^GROUP_GAUSSDB_APS-[a-zA-Z0-9-_]{32}in(14|20)$.

Range

Generally, the value is GROUP_GAUSSDB_APS-instance-ID.

Default Value

N/A

log_stream_name

Yes

String

Definition

LTS log stream name.

Constraints

The value must match the regular expression ^STREAM_APS_FULL_SQL-[a-zA-Z0-9-_]{32}in(14|20)$.

Range

Generally, the value is STREAM_APS_FULL_SQL-instance-ID.

Default Value

N/A

category

Yes

String

Definition

Category name of SQL statements.

Constraints

• Common SQL statements are classified into six categories. Each category corresponds to a fixed list of SQL statements, which are matched by prefix.
• In other scenarios, you can use custom categories. You can set the prefixes for SQL statements to be collected as required.

Range

• all: All SQL statements are collected, regardless of their types.
• ddl: Only DDL statements are collected, including the following SQL statements:

  CREATE, ALTER, DROP, TRUNCATE, REINDEX, VACUUM, ANALYZE, DECLARE, MOVE, and CLOSE

• dml: Only DML statements are collected, including the following SQL statements:

  INSERT, UPDATE, DELETE, MERGE, SHOW, EXPLAIN, PREPARE, LOCK, COPY, EXECUTE, and DEALLOCATE

• dcl: Only DCL statements are collected, including the following SQL statements:

  GRANT, REVOKE, REASSIGN, and SET

• tcl: Only TCL statements are collected, including the following SQL statements:

  BEGIN, COMMIT, ROLLBACK, START, SAVEPOINT, CHECKPOINT, and RELEASE SAVEPOINT

• dql: Only DQL statements are collected, including the following SQL statement:

  SELECT

• custom: Custom statements are collected. Enter the prefixes of the SQL statements to be collected in the prefixes field.

Default Value

N/A

prefixes

No

Array of strings

Definition

Prefixes of SQL statements to be collected for the custom category. The default value is []. During the collection, prefixes are used to match SQL text.

Constraints

• This parameter is mandatory and cannot be left empty if category is set to custom.
• This parameter can be ignored if category is set to another value.

job_id

String

Definition

Job ID.

Range

N/A