Queries whether SQL data collector is enabled for a PolarDB cluster. The features of SQL data collector include audit logs and SQL Explorer.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No DescribeDBClusterAuditLogCollector

The operation that you want to perform. Set the value to DescribeDBClusterAuditLogCollector.

DBClusterId String Yes pc-***************

The ID of the cluster.

Response parameters

Parameter Type Example Description
CollectorStatus String Disabled

The status of SQL data collector. Valid values:

  • Enable: SQL data collector is enabled.
  • Disabled: SQL data collector is disabled.
RequestId String 59011D2B-2A38-4207-A86C-72BC1F882D19

The ID of the request.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/? Action=DescribeDBClusterAuditLogCollector
&DBClusterId=pc-***************
&<Common request parameters>

Sample success responses

XML format 

<DescribeDBClusterAuditLogCollectorResponse>
  <CollectorStatus>Disabled</CollectorStatus>
  <RequestId>59011D2B-2A38-4207-A86C-72BC1F******</RequestId>
</DescribeDBClusterAuditLogCollectorResponse>

JSON format 

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

Error codes

For a list of error codes, visit the API Error Center.