Help Center/ Document Database Service/ API Reference/ APIs V3.0 (Recommended)/ Log Information Queries/ Querying SQL Audit Policy
Updated on 2025-10-24 GMT+08:00
View PDF

Querying SQL Audit Policy

Function

This API is used to query the policy for SQL audit logs.

URI

  • URI format

    GET /v3/{project_id}/instances/{instance_id}/auditlog-policy

Table 1 Path parameters

Name

Mandatory

Type

IN

Description

project_id

Yes

string

path

Explanation:

Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

instance_id

Yes

string

path

Explanation:

Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Name

Mandatory

Type

IN

Description

X-Auth-Token

Yes

string

header

Definition

User token obtained from IAM. For details, see Authentication.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Table 3 Parameter description

Name

Type

Description

keep_days

Integer

The number of days for storing audit logs. The value is 0 when SQL audit is disabled.

audit_scope

String

The audit scope.

audit_types

Array of strings

The audit type.

Example Requests

https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/5cecca4c20e04146862651b8d385f26ain02/auditlog-policy

Example Responses

{
   "keep_days":7,
   "audit_scope":"all",
   "audit_types":["insert"]
}

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.

Parent topic: Log Information Queries