Help Center/ Relational Database Service/ API Reference (Ankara Region)/ API v3 (Recommended)/ DB Instance Management/ Changing a Single DB Instance to Primary/Standby DB Instances
Updated on 2024-04-11 GMT+08:00

Changing a Single DB Instance to Primary/Standby DB Instances

Function

This API is used to change a single DB instance to primary/standby DB instances.

  • Before calling an API, you need to understand the API in Authentication.

Constraints

  • Single DB instances with certain specifications cannot be changed to primary/standby DB instances.

URI

  • URI format

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

  • Example

    https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action

  • 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

  • Parameter description
    Table 2 Parameter description

    Name

    Mandatory

    Type

    Description

    single_to_ha

    Yes

    Object

    For details, see Table 3.

    Table 3 single_to_ha field data structure description

    Name

    Mandatory

    Type

    Description

    az_code_new_node

    Yes

    String

    Specifies the AZ code of the DB instance node.

  • Request example
    Changing the instance type from single to primary/standby for MySQL or PostgreSQL DB instances:
    {
    	"single_to_ha": {
    		"az_code_new_node": "az2xahz"
    	}
    }

Response

  • Normal response
    Table 4 Parameter description

    Name

    Type

    Description

    job_id

    String

    Indicates the job ID.

  • Example normal response
    {
    	"job_id": "2b414788a6004883a02390e2eb0ea227"
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.