Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Adding Nodes for an Instance
Updated on 2025-07-02 GMT+08:00
View PDF
Share

Adding Nodes for an Instance

Function

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

Constraints

This API supports the following instance types:

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx
  • GeminiDB Redis

The maximum and minimum storage space of each GeminiDB Redis instance depends on its node quantity and specifications. If the new storage space cannot meet the requirements for running the instance, nodes cannot be added.

This API supports both yearly/monthly and pay-per-use instances.

GeminiDB Influx does not allow you to add nodes to single-node instances.

GeminiDB Mongo allows you to add only read-only nodes for instances.

This API can be used to add nodes for two GeminiDB Redis instances between which there is a dual-active DR relationship.

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/enlarge-node

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

instance_id

Yes

String

Explanation:

Instance ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token

You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication.

Constraints:

N/A

Values:

N/A

Default value:

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

num

Yes

Integer

Explanation:

Number of new nodes.

Constraints:

The value must be a positive integer.

Values:

N/A

Default value:

N/A

subnet_id

No

String

Explanation:

ID of the subnet where the new node is deployed.

Constraints:

  • This parameter can be transferred when nodes are added to the GeminiDB Cassandra database 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.

Values:

N/A

Default value:

N/A

is_auto_pay

No

String

Explanation:

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.

Constraints:

N/A

Values:

  • true: An order is automatically paid from user's account.
  • false: An order is manually paid by a user. The default value is false.

Default value:

false

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Explanation:

Task ID. This parameter is returned only for pay-per-use instances.

Values:

N/A

order_id

String

Explanation:

Order ID. This parameter is returned only for yearly/monthly instances.

Values:

N/A

Example Request

  • URI example 
    POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/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

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instances