doc-exports/docs/rds/api-ref/rds_01_0103.html

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.

• Learn how to authorize and authenticate this API before using it.
• Before calling this API, obtain the required region and endpoint.

Constraints

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

URI

• URI format

  POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/action

• Example

  https://rds.eu-de.otc.t-systems.com/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.
  password	No	String	This parameter is mandatory only when a Microsoft SQL Server DB instance type is changed from single to primary/standby.

• Request example

  {
  	"single_to_ha": {
  		"az_code_new_node": "az2xahz",
  		"password": "Test@1234567"
  	}
  }

Response

• Normal response

  Table 4 Parameter description

  Name	Type	Description
  job_id	String	Indicates the task ID.

• Example normal response

  {
  	"job_id": "2b414788a6004883a02390e2eb0ea227"
  }

• Abnormal Response

  For details, see Abnormal Request Results.

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: DB Instance Management