查询主机列表
功能介绍
该接口用于查询输入集群的主机列表详情。
URI
- URI格式
- 参数说明
表1 路径参数 参数
是否必选
参数类型
描述
project_id
是
String
参数解释:
项目编号。获取方法,请参见获取项目ID。
约束限制:
不涉及
取值范围:
只能由英文字母和数字组成,且长度为[1-64]个字符。
默认取值:
不涉及
cluster_id
是
String
参数解释:
集群ID。如果指定集群ID,则获取该集群做过补丁更新的最新版本元数据。获取方法,请参见获取集群ID。
约束限制:
不涉及
取值范围:
只能由英文字母、数字以及“_”和“-”组成,且长度为[1-64]个字符。
默认取值:
不涉及
表2 Query参数 名称
是否必选
参数类型
说明
pageSize
否
Integer
参数解释:
分页查询每页返回的最大集群数量。
约束限制:
不涉及
取值范围:
1-2147483646
默认取值:
10
currentPage
否
Integer
参数解释:
当前查询页码。
约束限制:
不涉及
取值范围:
不涉及
默认取值:
1
请求参数
无
响应参数
参数名 |
参数类型 |
说明 |
---|---|---|
total |
Integer |
参数解释: 主机参数。 |
hosts |
Array of HostModel objects |
参数解释: 主机参数,请参见表4。 取值范围: 不涉及 |
参数名 |
参数类型 |
说明 |
---|---|---|
id |
String |
参数解释: 虚拟机ID。 取值范围: 不涉及 |
ip |
String |
参数解释: 虚拟机IP地址。 取值范围: 不涉及 |
availability_zone_id |
String |
参数解释: 可用区域。 取值范围: 不涉及 |
tags |
Array of TagPlain objects |
参数解释: 标签列表信息,请参见表5 |
flavor |
String |
参数解释: 虚拟机规格ID。 取值范围: 不涉及 |
type |
String |
参数解释: 虚拟机类型,当前支持MasterNode,CoreNode,TaskNode。 取值范围: 不涉及 |
name |
String |
参数解释: 虚拟机名称。 取值范围: 不涉及 |
status |
String |
参数解释: 虚拟机当前状态。 取值范围: 不涉及 |
resource_id |
String |
参数解释: 节点资源ID。 取值范围: 不涉及 |
mem |
String |
参数解释: 内存。 取值范围: 不涉及 |
cpu |
String |
参数解释: CPU核数。 取值范围: 不涉及 |
root_volume_size |
String |
参数解释: 操作系统盘容量。 取值范围: 不涉及 |
data_volume_type |
String |
参数解释: 数据盘类型。 取值范围: 不涉及 |
data_volume_size |
Integer |
参数解释: 数据盘容量。 取值范围: 不涉及 |
data_volume_count |
Integer |
参数解释: 数据盘个数。 取值范围: 不涉及 |
node_group_name |
String |
参数解释: 节点组名称。 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
参数解释: 标签的键。 取值范围: 标签的key值可以包含任意语种字母、数字、空格和_.:=+-@,但首尾不能含有空格,不能以_sys_开头。 |
value |
String |
参数解释: 标签的值。 取值范围: 标签的value值可以包含任意语种字母、数字、空格和_.:=+-@,但首尾不能含有空格,不能以_sys_开头。 |
请求示例
GET /v1.1/{project_id}/clusters/{cluster_id}/hosts
响应示例
状态码:200
查询主机列表信息成功。
{ "total" : "5", "hosts" : [ { "id" : "063d1d47-ae91-4a48-840c-b3cfe4efbcf0", "name" : "a78e161c-d14f-4b68-8c2d-0219920ce844_node_core_IQhiC", "ip" : "192.168.0.169", "availability_zone_id" : null, "tags" : null, "status" : "ACTIVE", "resource_id" : "95c1eabc-ed1d-4037-97d1-62f0587790c7", "flavor" : "c2.2xlarge.linux.mrs", "type" : "Core", "mem" : "16384", "cpu" : "8", "root_volume_size" : "480", "data_volume_type" : "SATA", "data_volume_size" : "600", "data_volume_count" : "1", "node_group_name" : "node_group_1" }, { "id" : "dc5c6208-faa2-4727-a65a-2b1ce235d350", "name" : "a78e161c-d14f-4b68-8c2d-0219920ce844_node_master1_ASzkl", "ip" : "192.168.0.156", "availability_zone_id" : null, "tags" : null, "status" : "ACTIVE", "resource_id" : "95c1eabc-ed1d-4037-97d1-62f0587790c7", "flavor" : "c2.4xlarge.linux.mrs", "type" : "Master", "mem" : "32768", "cpu" : "16", "root_volume_size" : "480", "data_volume_type" : "SATA", "data_volume_size" : "600", "data_volume_count" : "1", "node_group_name" : "master_node_default_group" }, { "id" : "c0ce793d-848b-448a-835b-ea0cac534b09", "name" : "a78e161c-d14f-4b68-8c2d-0219920ce844_node_core_ANnRN", "ip" : "192.168.0.243", "availability_zone_id" : null, "tags" : null, "status" : "ACTIVE", "resource_id" : "95c1eabc-ed1d-4037-97d1-62f0587790c7", "flavor" : "c2.2xlarge.linux.mrs", "type" : "Core", "mem" : "16384", "cpu" : "8", "root_volume_size" : "480", "data_volume_type" : "SATA", "data_volume_size" : "600", "data_volume_count" : "1", "node_group_name" : "node_group_1" }, { "id" : "95c23e43-ef6e-4732-b6ed-a5f1c7779fae", "name" : "a78e161c-d14f-4b68-8c2d-0219920ce844_node_core_uRRiA", "ip" : "192.168.0.126", "availability_zone_id" : null, "tags" : null, "status" : "ACTIVE", "resource_id" : "95c1eabc-ed1d-4037-97d1-62f0587790c7", "flavor" : "c2.2xlarge.linux.mrs", "type" : "Core", "mem" : "16384", "cpu" : "8", "root_volume_size" : "480", "data_volume_type" : "SATA", "data_volume_size" : "600", "data_volume_count" : "1", "node_group_name" : "node_group_1" }, { "id" : "63bdbf75-1133-4a94-8c27-1fa12c8b9e70", "name" : "a78e161c-d14f-4b68-8c2d-0219920ce844_node_master2_StqFu", "ip" : "192.168.0.22", "availability_zone_id" : null, "tags" : null, "status" : "ACTIVE", "resource_id" : "95c1eabc-ed1d-4037-97d1-62f0587790c7", "flavor" : "c2.4xlarge.linux.mrs", "type" : "Master", "mem" : "32768", "cpu" : "16", "root_volume_size" : "480", "data_volume_type" : "SATA", "data_volume_size" : "600", "data_volume_count" : "1", "node_group_name" : "master_node_default_group" } ] }
异常状态码请参见状态码。
错误码
请参见错误码。