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

Obtaining the Local Retention Period of Binlogs

Function

This API is used to obtain 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:get

read

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

-

-

URI

  • URI format

    GET /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

    Instance ID.

Request

  • Request parameters

    None

  • URI example

    GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/fa60258325f6424ca1ba28653629d7b1in01/binlog/clear-policy

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Mandatory

    Type

    Description

    binlog_retention_hours

    Yes

    Integer

    Binlog retention period.

    binlog_clear_type

    No

    String

    Binlog retention policy. The value can be time or fast.

    • time: indicates that binlogs are retained by time.
    • fast: indicates that binlogs are not retained.
  • Example normal response 
    {
     "binlog_retention_hours": 3,
     "binlog_clear_type": "time"
}
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.

Parent topic: Log Information Queries