# 查询创建实例或扩容节点时需要的IP数量 - QueryingIPAddressesRequiredforCreatinganInstanceorAddingNodes #### 功能介绍 查询创建实例或扩容节点时需要的IP数量。 #### 接口约束 该接口支持如下数据库实例。 - GeminiDB Cassandra - GeminiDB Mongo - GeminiDB Influx - GeminiDB Redis #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDBforNoSQL/doc?api=ShowIpNumRequirement)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbfornosql:instance:getRequiredIpNums | Read | - | - | - | - | #### URI GET /v3/{project_id}/ip-num-requirement 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | node_num | 是 | Integer | **参数解释：** 创建实例或扩容节点的个数，单位：个。 **约束限制：** 不涉及。 **取值范围：** 1\~200。 **默认取值：** 不涉及。 | | engine_name | 否 | String | **参数解释：** 数据库接口名称。 **约束限制：** 没有传入实例ID的时候该字段为必传。 **取值范围：** - 取值为"cassandra"，表示GeminiDB Cassandra数据库接口。 - 取值为"mongodb"，表示GeminiDB Mongo数据库接口。 - 取值为"influxdb"，表示GeminiDB Influx数据库接口。 - 取值为"redis"，表示GeminiDB Redis数据库接口。 **默认取值：** 不涉及。 | | instance_mode | 否 | String | **参数解释：** 实例类型。 **约束限制：** 没有传入实例ID的时候该字段为必传。 **取值范围：** - 取值为"Cluster"，表示GeminiDB Cassandra、GeminiDB Influx、GeminiDB 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。可以调用[查询实例列表和详情 - QueryingInstancesandDetails](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | **参数解释：** 消耗的IP个数。 **取值范围：** 不涉及。 | #### 请求示例 URI样例 ``` GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/ip-num-requirement?node_num=3&engine_name=cassandra&instance_mode=Cluster ``` #### 响应示例 **状态码： 200** Success ``` { "count" : 3 } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。