文档首页/云数据库 RDS/API参考/API v3（推荐）/配置只读延迟库（PostgreSQL）/中止/恢复wal日志回放 - SwitchLogReplay
更新时间：2026-03-31 GMT+08:00
查看PDF
分享

中止/恢复wal日志回放 - SwitchLogReplay

功能介绍

中止/恢复wal日志在只读实例的回放。

在wal日志回放中止期间，如果流复制仍在正常进行，wal日志将继续被只读实例接受，最终将会填满可用的磁盘空间。这和中止的持续时间、wal日志的产生速率、只读实例可用的磁盘空间大小有关。

调试

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

授权信息

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

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:instance:switchLogReplay

-

-

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

-

-

接口约束

  • 如果您需要使用该功能，请联系客服提交开启配置只读延迟库的申请。
  • 该接口支持RDS for PostgreSQL 12及以上版本的只读实例。

URI

  • URI格式

    PUT /v3/{project_id}/instances/{instance_id}/log-replay/update

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    租户在某一region下的project ID。

    约束限制：

    非空。

    取值范围：

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

    默认取值：

    不涉及。

    instance_id

    是

    参数解释：

    实例ID。

    约束限制：

    非空。

    取值范围：

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

    默认取值：

    不涉及。

请求消息

  • 参数说明
    表2 参数说明

    参数

    是否必选

    参数类型

    描述

    pause_log_replay

    是

    String

    参数解释：

    中止/恢复wal日志回放。

    约束限制：

    不涉及。

    取值范围：

    • “true”表示中止回放。
    • “false”表示恢复回放。
    • 取其他值或值为空表示不做操作。

    默认取值：

    不涉及。

  • URI样例

    PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/49b9dd1d6f464ba4bc91df5cbd2e52ebin03/log-replay/update

  • 请求示例

    中止wal日志在只读实例的回放。

    { 
   "pause_log_replay" : "true"
 }

响应消息

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

    名称

    参数类型

    说明

    message

    String

    参数解释：

    调用结果。

    取值范围：

    调用正常时，返回“operate successfully”。

  • 正常响应样例 
    { 
   "message" : "operate successfully" 
 }
  • 异常响应

    请参见异常响应结果。

状态码

错误码

请参见错误码。

相关文档