ModifySQLCollectorRetention - ApsaraDB RDS - Alibaba Cloud Documentation Center

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

Operation description

Supported database engines

RDS MySQL

Precautions

After you shorten the log backup retention period, log backup files that are stored longer than the specified log backup retention period are immediately deleted.

References

Note : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

Use the SQL Explorer and Audit feature

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:ModifySQLCollectorRetention	update	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
ConfigValue	string	Yes	The log retention period that is allowed by the SQL Explorer feature on the instance. Valid values: 30: 30 days 180: 180 days 365: one year 1095: three years 1825: five years	365
ResourceGroupId	string	No	The resource group ID. You can call the DescribeDBInstanceAttribute operation to obtain the resource group ID.	rg-acfmyxxxx

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	21383BB3-3845-4628-B422-B4FB5C83DEBD

Examples

Sample success responses

JSONformat

{
  "RequestId": "21383BB3-3845-4628-B422-B4FB5C83DEBD"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidConfigValue	The ConfigValue is not valid.	The operation failed. The values of some parameters are invalid.
400	IncorrectSQLLogActiveStatus	Current DB instance SQL log active status does not support this operation.	The operation failed. The RDS instance is running.
400	InvalidSqlRetention.Malformed	Specified sql retention is not valid.	-
400	IncorrectSQLLogVersion	Current DB instance SQL log version does not support this operation.	This operation is not supported for the SQL log version of the current instance.

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