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.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
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:
| 365 |
ResourceGroupId | string | No | The resource group ID. You can call the DescribeDBInstanceAttribute operation to obtain the resource group ID. | rg-acfmyxxxx |
Response parameters
Examples
Sample success responses
JSON
format
{
"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.