Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ Log Information Queries/ Setting the Local Retention Period of Binlogs
Updated on 2025-12-09 GMT+08:00
View PDF
Share

Setting the Local Retention Period of Binlogs

Function

This API is used to set the local retention period of binlogs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:binlog:setPolicy

permission_management

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

-

-

Constraints

  • The local retention period of binlogs cannot be set during the DB instance creation.
  • This API is supported for RDS for MySQL DB instances only.

URI

  • URI format

    PUT /v3/{project_id}/instances/{instance_id}/binlog/clear-policy

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    instance_id

    Yes

    Specifies the DB instance ID.

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

binlog_retention_hours

Yes

Integer

Specifies the binlog retention period.

Value range: 0 to 168 (7 x 24)

Example Request

Set the local retention period of binlogs to 3 hours. 
PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/fa60258325f6424ca1ba28653629d7b1in01/binlog/clear-policy

{
     "binlog_retention_hours": 3
}

Response

  • Normal response
    Table 3 Parameters

    Parameter

    Type

    Description

    resp

    String

    Returns successful if the invoking is successful.

Status Code

Error Code

For details, see Error Codes.

Parent topic: Log Information Queries