Pausing or Resuming WAL Log Replay

Function

This API is used to pause or resume WAL replay on a read replica.

If WAL replay is paused but streaming replication is still in progress, WAL data will continue to be received by the read replica and will eventually fill up the storage. This depends on how long the replay is paused for, how quick WAL logs are generated, and how much available storage there is in your instance.

• Before calling this API, learn how to authenticate it.
• Before calling this API, learn about request header parameters.

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

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

• Parameter description

  Table 1 Parameters

  Parameter	Mandatory	Description
  project_id	Yes	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
  instance_id	Yes	Definition Instance ID. Constraints N/A Range N/A Default Value N/A

Request

• Parameter description

  Table 2 Parameters

  Parameter	Mandatory	Type	Description
  pause_log_replay	Yes	String	Definition Whether to pause or resume WAL replay. Constraints N/A Range true: Pause WAL replay. false: Resume WAL replay. Other values or left blank: No action will be taken. Default Value N/A

• URI example

  PUT https://rds.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/49b9dd1d6f464ba4bc91df5cbd2e52ebin03/log-replay/update

• Example request

  Pause WAL replay on a read replica.

  { 
     "pause_log_replay" : "true"
   }

Response

• Normal response

  Table 3 Parameters

  Parameter	Type	Description
  message	String	Definition Calling result. Range Returns operate successfully if the calling is successful.

• Example normal response

  { 
     "message" : "operate successfully" 
   }

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.