Updated on 2024-06-07 GMT+08:00

Obtaining the Replication Status of a DB Instance

Function

This API is used to obtain the primary/standby replication status of a DB instance.

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

Constraints

This API is available only to RDS for MySQL and RDS for SQL Server.

URI

  • URI format

    GET /v3/{project_id}/instances/{instance_id}/replication/status

  • 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://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/ instances/c90928717dc747e2a20099894a87c468in01/replication/status

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    replication_status

    String

    Replication status:

    • normal
    • abnormal

    abnormal_reason

    String

    Reasons why the replication is abnormal.

  • Example normal response
    {
        "replication_status": "normal",
        "abnormal_reason": ""
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.