Adding Nodes for an Instance_Instances_APIs v3_API Reference

Function

This API is used to add nodes for a specified instance.

Constraints

This API supports the following instance types:

GeminiDB Cassandra
GeminiDB Influx
GeminiDB Redis

URI

POST /v3/{project_id}/instances/{instance_id}/enlarge-node

**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	Instance ID.

Request Parameters

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
num	Yes	Integer	Number of new nodes.
subnet_id	No	String	ID of the subnet where the new node is deployed. This parameter can be transferred when nodes are added for GeminiDB Cassandra instances. The transferred subnet ID must belong to the VPC where the current instance is deployed. If this parameter is not transferred, the system will allocate a subnet with sufficient IP addresses for the new node.
is_auto_pay	No	String	Whether the order will be automatically paid after a yearly/monthly instance is created. This parameter does not affect the payment mode of automatic renewal. true: indicates that the order is automatically paid from the account. false: indicates that the order is manually paid from the account. The default value is false.

Response Parameters

Status code: 202

**Table 4** Response body parameters
Parameter	Type	Description
job_id	String	Task ID. This parameter is returned only for pay-per-use instances.
order_id	String	Order ID. This parameter is returned only for yearly/monthly instances.

Example Request

URI example

POST https://gaussdb-nosql.eu-west-101.myhuaweicloud.eu/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/enlarge-node

Adding a node
```
{
  "num" : 1
}
```

Example Response

Status code: 202

Accepted

Example response for a pay-per-use instance:

{
  "job_id" : "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
}

Example response for a yearly/monthly instance:

{
  "order_id" : "CS20070721568OVO9"
}

Status Codes

See Status Codes.

Error Codes

See Error Codes.

Adding Nodes for an Instance