Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Log Management/ Querying the Policy for SQL Audit Logs

Updated on 2025-09-04 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying the Policy for SQL Audit Logs

Function

This API is used to query the policy for SQL audit logs. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

GET /v3/{project_id}/instances/{instance_id}/audit-log-policy

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 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 contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
keep_days	Integer	Definition Number of days for storing audit logs. The value 0 indicates that SQL audit is disabled. Range 0–732
audit_types	Array of strings	Definition Actual operation types recorded in audit logs. If this parameter is left blank, no operation types are filtered out. Range The value range is dynamic.
all_audit_log_action	String	Definition All operation types that can be recorded in audit logs. Range N/A

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin07/audit-log-policy

Example Response

Status code: 200

Success.

{
  "keep_days" : 7,
  "audit_types" : [ "CREATE", "ALTER" ],
  "all_audit_log_action" : "{\"DCL\":\"CREATE_USER,DROP_USER,RENAME_USER,GRANT,REVOKE,ALTER_USER,ALTER_USER_DEFAULT_ROLE\",\"DDL\":\"CREATE,ALTER,DROP,RENAME,TRUNCATE,REPAIR,OPTIMIZE\",\"DML\":\"INSERT,DELETE,UPDATE,REPLACE,SELECT\",\"OTHER\":\"BEGIN/COMMIT/ROLLBACK,PREPARED_STATEMENT,CALL_PROCEDURE,KILL,SET_OPTION,CHANGE_DB,UNINSTALL_PLUGIN,UNINSTALL_PLUGIN,INSTALL_PLUGIN,SHUTDOWN,SLAVE_START,SLAVE_STOP,LOCK_TABLES,UNLOCK_TABLES,FLUSH,XA\"}"
}