EnableSqlAudit - PolarDB - Alibaba Cloud Documentation Center

Operation description

Note

The SQL audit and analysis feature of PolarDB-X 2.0 is free of charge. However, Simple Log Service charges fees for storage space, read traffic, number of requests, data transformation, and data shipping. For more information about the SQL audit feature, see Enable SQL audit and analysis.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardbx:EnableSqlAudit

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region in which the instance resides.	cn-hangzhou
DBInstanceId	string	Yes	The instance ID.	pxc-****************
ExpireAfterDays	integer	No	The number of days for which audit logs are retained. 0: Logs are not retained. Automatic log expiration is disabled. Greater than 0: Logs are automatically deleted after N days. Common values: 30, 45, 90, 180, and 365.	45
AuditAccountName	string	No	The name of the audit administrator account. > If the three-role mode is enabled, this parameter is required. For more information about the three-role mode, see Three-role mode.	test_daa
AuditAccountPassword	string	No	The password of the audit administrator account. > If the three-role mode is enabled, this parameter is required. For more information about the three-role mode, see Three-role mode.	Pw@11111

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful.	true
RequestId	string	The request ID.	DC3ABA3E-0F8A-4596-9104-F5167C******

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "DC3ABA3E-0F8A-4596-9104-F5167C******"
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBInstance.NotFound	The specified DB instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.