Updated on 2024-01-12 GMT+08:00

Setting SQL Audit

Function

This API is used to set a policy for SQL audit logs.

  • Before calling an API, you need to understand the API in Authentication.

Constraints

This API is available only to RDS for MySQL and RDS for PostgreSQL.

URI

  • URI format

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

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    instance_id

    Yes

    Specifies the DB instance ID.

Request

Parameter description
Table 2 Parameter description

Name

Mandatory

Type

Description

keep_days

Yes

Integer

Specifies the number of days for storing audit logs. The value range is from 0 to 732.

  • 0: indicates that SQL audit is disabled.
  • 1 to 732: indicates the retention days for audit logs after SQL audit is enabled.

reserve_auditlogs

No

Boolean

This parameter is valid only when SQL audit is disabled.

  • true (default): indicates that historical audit logs will be reserved for some time when SQL audit is disabled.
  • false: indicates that historical audit logs will be deleted immediately when SQL audit is disabled.

Example Request

  • Enabling SQL Audit, with audit log retention period set to 5 days
    {
        "keep_days":5
    }
  • Disabling SQL Audit and deleting existing historical audit logs
    {
        "keep_days":0,
        "reserve_auditlogs":false
    }

Response

Status Code

Error Code

For details, see Error Codes.