Manually Switching Primary/Standby DB Instances

Function

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

  • 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 supported for MySQL and PostgreSQL.

  • This API is supported for primary/standby DB instances only.

  • Primary/standby DB instances cannot be manually switched if they are in any of the following statuses:

    • For MySQL and PostgreSQL: creating, rebooting, upgrading, changing instance class, restoring, changing port, or creating database account

    • For MySQL: deleting database account

URI

  • URI format

    PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/failover

  • Parameter description

    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the 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

    Specifies the DB instance ID.

Request

  • Request example

    PUT https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/failover

    {}

Response

  • Normal response

    Name

    Description

    workflowId

    Indicates the task 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

Error Code

For details, see Error Codes.

last updated: 2024-11-08 14:19 UTC - commit: aae1b12bfa160248d933bc69155302800af0d0fd