Enables or disables SQL collector for a PolarDB cluster. Features related to SQL collector include audit log and SQL Explorer. By default, when you call this operation to enable SQL collector for a PolarDB cluster in a region that supports DAS Enterprise Edition, the latest DAS Enterprise Edition supported by the region is enabled. For information about the database engines and regions supported by each DAS Enterprise edition, see the "Supported databases and regions" section of the "Editions and supported features" topic.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
polardb:ModifyDBClusterAuditLogCollector | Write |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBClusterId | string | Yes | The cluster ID. | pc-*************** |
CollectorStatus | string | Yes | Specifies whether to enable or disable SQL collector. Valid values:
| Enable |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "22C0ACF0-DD29-4B67-9190-B7A48C******"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
403 | OperationDenied.DBClusterStatus | The operation is not permitted due to status of cluster. | The PolarDB cluster does not support this operation in the current state. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||
---|---|---|---|---|---|---|
2023-06-12 | The Error code has changed | see changesets | ||||
|