文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 实例管理/ 查询创建实例或扩容节点时需要的IP数量
更新时间：2024-09-03 GMT+08:00
查看PDF
分享

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

功能介绍

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

接口约束

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

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

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET https://{Endpoint}/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 Cassandra、GeminiDB Influx、GeminiDB Redis集群实例类型。
  • 取值为“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.cn-north-7.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/ip-num-requirement?node_num=3&engine_name=cassandra&instance_mode=Cluster
  • 请求体样例

    无。

响应示例

状态码： 200

Success

{ 
  "count" : 3 
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理

相关文档