DescribeSQLCollectorPolicy - ApsaraDB RDS - Alibaba Cloud Documentation Center

You can call the DescribeSQLCollectorPolicy operation to query the status of the SQL Explorer (SQL Audit) feature on an ApsaraDB RDS instance.

Operation Description

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

Enable
Disabled

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
rds:DescribeSQLCollectorPolicy	READ	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	None	ETnLKlblzczshOTUbOCzxxxxxxxxxx
DBInstanceId	string	Yes	The ID of the request.	rm-uf6wjk5xxxxxxx
ResourceGroupId	string	No	The operation that you want to perform. Set the value to DescribeSQLCollectorPolicy.	rg-acfmyxxxxxxxxxx

Response parameters

Parameter	Type	Description	Example
	object

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 time

Summary of changes

Operation

2022-06-23

API Description Update

Change item	Change content
API Description	API Description Update