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

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

  • URI example

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/5cecca4c20e04146862651b8d385f26ain02/auditlog-policy

Request Parameters

Parameter description

Table 1 Request parameters

Name

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

Explanation:

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

Constraints:

N/A

Value range:

N/A

Default value:

N/A

project_id

string

path

Yes

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

string

path

Yes

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

Response Parameters

  • Parameter description
    Table 2 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.
  • Response example 
    {
   "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