DescribeSQLCollectorRetention - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the retention period of the log files that are generated by the SQL Explorer feature for an instance.

Operation description

Supported database engines

MySQL
PostgreSQL
SQL Server

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.

Operation	Access level	Resource type	Condition key	Associated operation
rds:DescribeSQLCollectorRetention	get	*DBInstance `acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. You can call the DescribeDBInstances operation to query the instance ID.	rm-uf6wjk5xxxxxxx
ResourceGroupId	string	No	The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.	rg-acfmyxxxx

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
ConfigValue	string	The retention period of the log files that are generated by the SQL Explorer feature. Valid values: 30: 30 days 180: 180 days 365: one year 1095: three years 1825: five years Note The retention period of the log files that are generated by the SQL Explorer feature on ApsaraDB RDS for PostgreSQL instances and ApsaraDB RDS for SQL Server instances is fixed as 30 days.	365
RequestId	string	The request ID.	D5CEDCC2-CA75-43F7-9508-92F418CE6391

Examples

Sample success responses

JSONformat

{
  "ConfigValue": "365",
  "RequestId": "D5CEDCC2-CA75-43F7-9508-92F418CE6391"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidComment	Should specify a policy name.	The name of the policy is left unspecified.

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. The Error code has changed	View Change Details