Updated on 2024-08-28 GMT+08:00

Obtaining the Delayed Replay Status of WAL Logs

Function

This API is used to obtain the delayed WAL replay status of a read replica.

  • Before calling an API, you need to understand the API in Authentication.

Constraints

  • To use this function, contact customer service to obtain required permissions.
  • This function is only available to read replicas of RDS for PostgreSQL 12 and later versions.

URI

  • URI format

    GET /v3/{project_id}/instances/{instance_id}/replay-delay/show

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    instance_id

    Yes

    Instance ID.

Request

  • Parameter description

    None

  • URI example

    GET https://rds.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/49b9dd1d6f464ba4bc91df5cbd2e52ebin03/replay-delay/show

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    cur_delay_time_mills

    int

    Configured delay, in ms.

    The replication delay is controlled by the recovery_min_apply_delay parameter. You can modify this parameter to change the delay for replaying WAL logs. For details about how to modify this parameter, see Modifying Parameters of a Specified Instance.

    delay_time_value_range

    String

    Value range for the delay.

    real_delay_time_mills

    int

    Actual delay, in ms.

    cur_log_replay_paused

    boolean

    Current log replay status.

    • true: The replay is paused.
    • false: The replay is normal.

    latest_receive_log

    String

    Latest received log position.

    latest_replay_log

    String

    Latest replayed log position.

  • Example normal response
    { 
       "cur_delay_time_mills" : 0,
       "delay_time_value_range" : "0-2147483647",
       "real_delay_time_mills" : 0,
       "cur_log_replay_paused" : true,
       "latest_receive_log" : "0/8000060",
       "latest_replay_log" : "0/8000060"
     }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.