Updated on 2024-11-19 GMT+08:00

Querying the Recovery Time Window of WAL Logs

Function

This API is used to query the recovery time window of WAL logs for a read replica. After this API is called, a recovery time window (recovery_min_time, recovery_max_time] is returned. The interval is left-open and right-closed. You can change the value of recovery_target_time to a time point in the time window to set the target replay time. For details about how to modify instance parameters, see Modifying Parameters of a Specified Instance.

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

Constraints

  • To use this function, contact customer service to obtain the permission required for configuring replication delay for a read replica.
  • This API is only available to read replicas of RDS for PostgreSQL 12 and later versions.

URI

  • URI format

    GET /v3/{project_id}/instances/{instance_id}/recovery-time

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Explanation:

    Project ID of a tenant in a region.

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

    Constraints:

    The value cannot be empty.

    Value range:

    N/A

    Default value:

    N/A

    instance_id

    Yes

    Explanation:

    Instance ID.

    Constraints:

    The value cannot be empty.

    Value range:

    N/A

    Default value:

    N/A

Request

  • Parameter description

    None

  • URI example

    GET https://rds.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/49b9dd1d6f464ba4bc91df5cbd2e52ebin03/recovery-time

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    recovery_min_time

    String

    Explanation:

    Left boundary of the recovery time window (excluded).

    Value range:

    N/A

    recovery_max_time

    String

    Explanation:

    Right boundary of the recovery time window (included).

    Value range:

    N/A

  • Example normal response
    { 
       "recovery_min_time" : "2024-08-17 19:17:35+10",
       "recovery_max_time" : "2024-08-20 22:53:28+10"
     }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.