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

Example Request

• Enable SQL Audit and set the audit log retention period to 5 days.

  PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/auditlog-policy
  
  {
      "keep_days":5,
      "audit_types": [
      "CREATE_USER"
      ]
  }

• Disable SQL Audit and delete existing historical audit logs.

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

Response

• Normal response

  Table 3 Parameters

  Parameter	Type	Description
  status	String	Explanation: Result of setting SQL audit. Value range: COMPLETED

• Example normal response

  {
    "status":"COMPLETED"
  }

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.