文档首页/ 云数据库 GeminiDB/ API参考/ API v3(推荐)/ 实例管理/ 查询创建实例或扩容节点时需要的IP数量
更新时间:2025-09-16 GMT+08:00

查询创建实例或扩容节点时需要的IP数量

功能介绍

查询创建实例或扩容节点时需要的IP数量。

接口约束

该接口支持如下数据库实例。

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户在某一region下的project ID。获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

node_num

Integer

参数解释:

创建实例或扩容节点的个数。

约束限制:

不涉及。

取值范围:

最大支持输入200。

默认取值:

不涉及。

engine_name

String

参数解释:

数据库接口名称。

约束限制:

没有传入实例ID的时候该字段为必传。

取值范围:

  • 取值为“cassandra”,表示GeminiDB Cassandra数据库接口
  • 取值为“mongodb”,表示GeminiDB Mongo数据库接口
  • 取值为“influxdb”,表示GeminiDB Influx数据库接口
  • 取值为“redis”,表示GeminiDB Redis数据库接口

默认取值:

不涉及。

instance_mode

String

参数解释:

实例类型。

约束限制:

没有传入实例ID的时候该字段为必传。

取值范围:

  • 取值为“Cluster”,表示GeminiDB CassandraGeminiDB InfluxGeminiDB Redis 经典部署模式Proxy集群实例类型。
  • 取值为“CloudNativeCluster”,表示GeminiDB Cassandra、GeminiDB Influx、GeminiDB Redis云原生部署模式集群实例类型。

  • 取值为“RedisCluster”,表示GeminiDB Redis Cluster经典部署模式集群实例类型。

  • 取值为“Replication”,表示GeminiDB Redis经典部署模式主备实例类型。
  • 取值为“InfluxdbSingle”,表示GeminiDB Influx经典部署模式单节点实例类型。
  • 取值为“ReplicaSet”,表示GeminiDB Mongo副本集实例类型。

默认取值:

不涉及。

instance_id

String

参数解释:

实例ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

参数解释:

消耗的IP个数。

取值范围:

不涉及。

请求示例

  • URI样例
    GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/ip-num-requirement?node_num=3&engine_name=cassandra&instance_mode=Cluster
  • 请求体样例

    无。

响应示例

状态码: 200

Success

{ 
  "count" : 3 
}

状态码

请参见状态码

错误码

请参见错误码