Performing a Primary/Secondary Switchover in a Replica Set Instance

Function

This API is used to perform a primary/secondary switchover in a replica set instance.

Constraints

• This API supports only DDS replica sets.
• This API can freeze instances except abnormal instances.

URI

• URI format

  POST /v3/{project_id}/instances/{instance_id}/switchover

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Specifies the project ID of a tenant in a region.
  instance_id	Yes	Specifies the DB instance ID.

Requests

• Request header

  POST https://DDS endpoint/v3/{project_id}/instances/{instance_id}/switchover

• Example request

  N/A

Responses

• Parameter description

  Table 2 Parameter description

  Name	Type	Description
  job_id	String	Indicates the task ID.

• Response example

  {
      "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
  }

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.