Last updated: 2021-12-01 10:57:53

1. API Description

Domain name for API request:

This API is used to modify the number of days for retention of database backup logs.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: ModifyLogFileRetentionPeriod.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID in the format of tdsql-ow728lmc.
Days Yes Integer Retention days up to 30

3. Output Parameters

Parameter Name Type Description
InstanceId String Instance ID in the format of tdsql-ow728lmc.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying backup log retention days

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "InstanceId": "tdsql-ige1a5k3",
    "RequestId": "7f642839-f40d-4faf-8d84-be7894ce048a"

5. Developer Resources


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.OssOperationFailed Failed to request the backend API.
InternalError.CamAuthFailed CAM authentication request failed.
InternalError.DbOperationFailed Failed to query the database.
InvalidParameter.GenericParameterError An error occurred while verifying parameter validity.
InvalidParameterValue.IllegalLogSaveDays The number of days for log retention after modification is either too high or too low.
ResourceUnavailable.InstanceAlreadyDeleted The database instance has been deleted.
ResourceUnavailable.InstanceStatusAbnormal Incorrect database instance status. Operations are not allowed.
UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.