doc-exports/docs/rds/api-ref/rds_05_0033.html

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.
• Before calling this API, obtain the required region and endpoint.

Constraints

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

URI

• URI format

  GET https://{endpoint}/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. To obtain the value, see Obtaining a Project ID.
  instance_id	Yes	Instance ID.

Request

• Parameter description

  Table 2 Request header parameters

  Parameter	Mandatory	Type	Description
  X-Auth-Token	Yes	String	Specifies the user token. The user token is a response to the API used to obtain a user token.

• URI example

  GET https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/c90928717dc747e2a20099894a87c468in01/replication/status

Response

• Normal response

  Table 3 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

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: DB Instance Management