Updated on 2026-01-08 GMT+08:00

Querying SQL Audit Policy

Description

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

URI

  • URI format

    GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog-policy

Table 1 Path parameters

Parameter

Type

IN

Mandatory

Description

project_id

string

path

Yes

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

instance_id

string

path

Yes

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.

Request Parameters

Table 2 Request header parameters

Parameter

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

User token

Response Parameters

Table 3 Parameter description

Parameter

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 response
    {
       "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.