Files
doc-exports/docs/geminidb/api-ref/nosql_05_0051.html
wangdengke2 59805c5073 GeminiDB_API
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
2026-03-12 09:56:41 +00:00

11 KiB

Adding Nodes for an Instance

Function

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

Constraints

This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.

URI

POST https://{Endpoint}/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 parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

MIME type of the request body. application/json is recommended.

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.

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Task ID.

Example Requests

  • URI example
    POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/enlarge-node
  • Adding a node
    {
      "num" : 1
    }

Example Responses

Status code: 202

Accepted

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

Status Codes

See Status Codes.

Error Codes

See Error Codes.