Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Log Management/ Setting SQL Audit
Updated on 2025-09-04 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Setting SQL Audit

Function

This API is used to set a policy for SQL audit logs. Before calling this API:

URI

PUT /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

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

application/json

Default Value

application/json

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

keep_days

Yes

Integer

Definition

Number of days for storing audit logs. The value 0 indicates that SQL audit is disabled.

Constraints

N/A

Range

0–732

Default Value

7

reserve_audit_logs

No

Boolean

Definition

This parameter is only valid when SQL audit is disabled.

Constraints

N/A

Range

  • true: Historical audit logs will be reserved for some time when SQL audit is disabled.

  • false: Historical audit logs will be deleted immediately when SQL audit is disabled.

Default Value

true

audit_types

No

Array of strings

Definition

Operation types recorded in audit logs, which are dynamic. If this parameter is left blank, all operation types will be recorded by default.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

result

String

Definition

Results of setting SQL audit.

Range

The value can be COMPLETED or FAILED.

job_id

String

Definition

Task flow ID.

Range

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

  • Updating the policy for SQL audit logs

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

{
  "keep_days" : 5,
  "audit_types" : [ "SELECT" ]
}

  • Disabling SQL audit

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

{
  "keep_days" : 0,
  "reserve_audit_logs" : false
}

Example Response

Status code: 200

Success.

{
  "result" : "COMPLETED",
  "job_id" : "e7a7535b-eb9b-45ac-a83a-020dc5016d94"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Log Management