文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 获取日志信息/ 获取Binlog本地保留时长 - ShowBinlogClearPolicy
更新时间：2026-03-11 GMT+08:00
查看PDF
分享

获取Binlog本地保留时长 - ShowBinlogClearPolicy

功能介绍

获取Binlog本地保留时长。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:binlog:get

read

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

-

-

URI

  • URI格式

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

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    租户在某一region下的project ID。

    约束限制：

    非空。

    取值范围：

    获取方法请参见获取项目ID。

    默认取值：

    不涉及。

    instance_id

    是

    参数解释：

    实例ID。

    约束限制：

    非空。

    取值范围：

    该参数值可调用查询数据库实例列表接口，通过表4中的“id”获取。

    默认取值：

    不涉及。

请求消息

  • 请求参数

    无。

  • URI样例

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

响应消息

  • 正常响应要素说明
    表2 要素说明

    名称

    是否必选

    参数类型

    说明

    binlog_retention_hours

    是

    Integer

    参数解释：

    Binlog本地保留时长（小时）。

    取值范围：

    0~7*24小时。

    binlog_clear_type

    否

    String

    参数解释：

    Binlog保留策略。

    取值范围：

    • time：表示按时长保留Binlog文件。
    • fast：表示快速清理，不保留Binlog文件。
  • 正常响应样例 
    {
     "binlog_retention_hours": 3,
     "binlog_clear_type": "time"
}
  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题： 获取日志信息

相关文档