Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: Ru, Li Yi <liyiru7@huawei.com>
Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>

2024-07-04 11:26:33 +00:00

10 KiB

Raw Blame History

Adding Nodes for an Instance

Function

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

Constraints

This API supports GeminiDB Cassandra instances.

URI

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

**Table 1** Path 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
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 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.

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

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instances

10 KiB Raw Blame History