All Products
Search
Document Center

ApsaraDB RDS:DescribeSQLCollectorPolicy

Last Updated:Jul 05, 2024

Queries the status of the SQL Explorer (SQL Audit) feature for an ApsaraDB RDS instance.

Operation description

Supported database engines

  • MySQL
  • PostgreSQL
  • SQL Server

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

ETnLKlblzczshOTUbOCzxxxxxxxxxx
DBInstanceIdstringYes

The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

rm-uf6wjk5xxxxxxx
ResourceGroupIdstringNo

The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.

rg-acfmyxxxxxxxxxx

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

1AD222E9-E606-4A42-BF6D-8A4442913CEF
SQLCollectorStatusstring

The status of the SQL Explorer (SQL Audit) feature. Valid values:

  • Enable
  • Disabled
Enable
StoragePeriodinteger

A reserved parameter.

0

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "SQLCollectorStatus": "Enable",
  "StoragePeriod": 0
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-04-18The Error code has changedView Change Details
2022-06-23API Description UpdateView Change Details