Manually Switching Primary/Standby DB Instances

Function

This API is used to manually switch primary/standby DB instances as required.

• Before calling this API, learn how to authenticate it.
• Before calling this API, learn about request header parameters.

Constraints

• This API is supported for primary/standby DB instances only.
• This operation cannot be performed if the DB instance is in any of the following statuses: creating, rebooting, upgrading, changing instance class, restoring, changing port, deleting database account, or creating database account.
• The primary/standby switchover does not change the floating IP address of your instance.

URI

• URI format

  PUT /v3/{project_id}/instances/{instance_id}/failover

• Parameter description

  Table 1 Parameter description

  Name	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	Specifies the DB instance ID.

Request

Example Request

• Perform a primary/standby switchover.

  {}

• Perform a forcible primary/standby switchover.

  {
  "force":true
  }

Response

• Normal response

  Parameter	Description
  workflowId	Indicates the workflow ID.
  instanceId	Indicates the DB instance ID.
  nodeId	Indicates the node ID.

• Example normal response

  {
      "workflowId":"072beb09-0573-40bf-bfe8-4be5cec9e85a",
      "instanceId":"794c38e5309344818f4b33b86ebce9b4in03",
      "nodeId":"b94ba815747040f1b0d641cd13364a06no03"
  }

• 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.