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 operation cannot be performed on frozen or abnormal instances.

URI

  • URI format

    POST https://{Endpoint}/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 instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.

Requests

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

Status Code:202.

For more information, see Status Code.

Error Code

For more information, see Error Code.