doc-exports/docs/gaussdb_mysql/api-ref/gaussdb_04_0015.html

Creating a Read Replica

Function

This API is used to create a read replica. Before using this API:

• Learn how to authorize and authenticate it.
• Obtain the required region and endpoint.

URI

POST /v3/{project_id}/instances/{instance_id}/nodes/enlarge

Table 1 URI parameters

Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
instance_id	Yes	String	DB instance ID, which is compliant with the UUID format.

Request Parameters

Table 2 Request header parameters

Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.
X-Language	No	String	Language.

Table 3 Request body parameters

Parameter	Mandatory	Type	Description
priorities	Yes	Array of integers	Failover priority of a read replica. Failover priority ranges from 1 for the first priority to 16 for the last priority. This priority determines the order in which read replicas are promoted when recovering from a primary node failure. Read replicas with the same priority have a same probability of being promoted to the new primary node.

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter	Type	Description
instance_id	String	DB instance ID.
node_names	Array of strings	Node name list
job_id	String	Read replica creation task ID. This parameter is returned only when a pay-per-use read replica is created.

Status code: 400

Table 5 Response body parameters

Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

Table 6 Response body parameters

Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Creating a read replica

POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/nodes/enlarge
{
  "priorities" : [ 1, 2 ]
}

Example Response

Status code: 201

Success.

{
  "instance_id" : "ba62a0b83a1b42bfab275829d86ac0fdin07",
  "node_names" : [ "gauss-ccf5_node03" ],
  "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Managing DB Instances