Files

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

12 KiB

Raw Blame History

Querying IP Addresses Required for Creating an Instance or Adding Nodes

Function

This API is used to query IP addresses required for creating an instance or adding nodes to an instance.

Constraints

This API supports the following instances:

GeminiDB Cassandra
GeminiDB Influx

URI

GET https://{Endpoint}/v3/{project_id}/ip-num-requirement

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

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
node_num	Yes	Integer	Nodes required for creating or scaling out an instance The maximum value is 200.
engine_name	No	String	DB engine type cassandra: GeminiDB Cassandra DB type influxdb: GeminiDB Influx DB type
instance_mode	No	String	Instance type. The value is case-sensitive. If no instance ID is transferred, this parameter is mandatory. The value can be: Cluster: GeminiDB Cassandra cluster instance CloudNativeCluster: GeminiDB Influx cluster (performance-enhanced) instance with cloud native storage
instance_id	No	String	Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If there are no instances available, call the API described in Creating an Instance to create one.

Request Parameters

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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
count	Integer	Number of IP addresses used.

Example Requests

URI example

GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/ip-num-requirement?node_num=3&engine_name=cassandra&instance_mode=Cluster

Example request body
None

Example Responses

Status code: 200

Success

{ 
  "count" : 3 
}

Status Codes

See Status Codes.

Error Codes

See Error Codes.

Parent topic: Instances

12 KiB Raw Blame History