All Products
Search
Document Center

PolarDB:DescribeDBClusterAuditLogCollector

Last Updated:Jan 12, 2024

Describe SQL collector for a PolarDB cluster. Features related to SQL collector include audit log and SQL Explorer.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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.
OperationAccess levelResource typeCondition keyAssociated operation
polardb:DescribeDBClusterAuditLogCollectorREAD
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the cluster.

pc-***************

Response parameters

ParameterTypeDescriptionExample
object
CollectorStatusstring

The status of SQL collector. Valid values:

  • Enable
  • Disabled
Disabled
RequestIdstring

The request ID.

59011D2B-2A38-4207-A86C-72BC1F882D19

Examples

Sample success responses

JSONformat

{
  "CollectorStatus": "Disabled",
  "RequestId": "59011D2B-2A38-4207-A86C-72BC1F882D19"
}

Error codes

HTTP status codeError codeError messageDescription
404InvalidDBClusterId.MalformedThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.

For a list of error codes, visit the Service error codes.