Modify SQL audit settings using ModifyAuditLogConfig - AnalyticDB - Alibaba Cloud - AnalyticDB

Operation description

For the endpoints of AnalyticDB for MySQL, see Endpoints.

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

adb:ModifyAuditLogConfig

update

DBClusterLakeVersion

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster. Note Call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL clusters within a region.	amv-t4nj8619bz2w3****
RegionId	string	Yes	The region ID of the cluster. Note Call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
AuditLogStatus	string	Yes	The desired status of the SQL audit feature. Valid values: on off Note After you disable SQL audit, all SQL audit logs are deleted. Export audit logs before disabling. For more information, see DescribeAuditLogRecords. When you re-enable SQL audit, only logs generated from the re-enablement time are available for queries.	on
EngineType	string	No	The type of the compute engine. Valid values: XIHE (default) SPARK	XIHE

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	CDC59E56-BD07-56CA-A05F-B7907DE5C862
UpdateSucceed	boolean	Indicates whether the SQL audit status was updated. Valid values: true false	true

Examples

Success response

JSON format

{
  "RequestId": "CDC59E56-BD07-56CA-A05F-B7907DE5C862",
  "UpdateSucceed": true
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.