Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Querying IP Addresses Required for Creating an Instance or Adding Nodes
Updated on 2025-12-04 GMT+08:00
View PDF
Share

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 Mongo
  • GeminiDB Influx
  • GeminiDB Redis

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    gaussdbfornosql:instance:getRequiredIpNums

    Read

    -

    -

    -

    -

URI

GET /v3/{project_id}/ip-num-requirement

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A
Table 2 Query parameters

Parameter

Mandatory

Type

Description

node_num

Yes

Integer

Definition

Nodes required for creating or scaling out an instance

Constraints

N/A

Range

The maximum value is 200.

Default Value

N/A

engine_name

No

String

Definition

DB API name.

Constraints

If no instance ID is transferred, this parameter is mandatory.

Range

  • cassandra: GeminiDB Cassandra API
  • mongodb: GeminiDB Mongo API
  • influxdb: GeminiDB Influx API
  • redis: GeminiDB Redis API

Default Value

N/A

instance_mode

No

String

Definition

Instance type

Constraints

If no instance ID is transferred, this parameter is mandatory.

Range

  • Cluster: GeminiDB Cassandra, GeminiDB Influx, and GeminiDB Redis instances in a proxy cluster

  • CloudNativeCluster: cluster GeminiDB Cassandra, Influx, or Redis instance with cloud native storage

  • RedisCluster: Redis Cluster GeminiDB Redis instance with classic storage

  • Replication: primary/standby GeminiDB Redis instance with classic storage
  • InfluxdbSingle: single-node GeminiDB Influx instance with classic storage
  • ReplicaSet: GeminiDB Mongo instance in a replica set

Default Value

N/A

instance_id

No

String

Definition

Instance ID

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Definition

Number of IP addresses used.

Range

N/A

Example Requests

  • URI example 
    GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/ip-num-requirement?node_num=3&engine_name=cassandra&instance_mode=Cluster
  • Example request body

    None

Example Responses

Status code: 200

Successful response

{ 
  "count" : 3 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instances