查询主机集群列表 （推荐）
功能介绍
按条件查询主机集群列表。
调用方法
请参见如何调用API。
URI
GET /v1/resources/host-groups
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID 最小长度：32 最大长度：32 |
name |
否 |
String |
主机集群模糊查询信息 最小长度：1 最大长度：256 |
os |
否 |
String |
操作系统：windows|linux 枚举值：
|
page_index |
否 |
Integer |
页码数 最小值：0 |
page_size |
否 |
Integer |
每页显示的条目数量，默认为10 最小值：1 最大值：1000 |
sort_field |
否 |
String |
排序字段：nick_name|name|owner_name|create_time，不传使用默认排序 |
sort_type |
否 |
String |
排序方式：DESC、ASC，默认为DESC 枚举值：
|
is_proxy_mode |
否 |
Integer |
是否为代理机 |
slave_cluster_id |
否 |
String |
自定义资源池id |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 最小长度：0 最大长度：20000 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
status |
String |
请求状态 |
total |
Integer |
主机集群个数 最小值：0 最大值：1000 |
result |
Array of HostClusterInfo objects |
主机集群详情响应体 数组长度：0 - 1000 |
参数 |
参数类型 |
描述 |
|---|---|---|
id |
String |
主机集群id 最小长度：32 最大长度：32 |
host_count |
Integer |
集群内主机数量，一个主机集群内最多可添加200台主机 最小值：0 最大值：200 |
name |
String |
主机集群名 |
project_id |
String |
项目ID，获取方式请参见获取项目ID。 |
os |
String |
操作系统：windows|linux |
slave_cluster_id |
String |
slave集群id，默认为null时使用默认slave集群，用户自定义slave时为slave集群id |
created_by |
UserInfo object |
用户信息 |
description |
String |
描述 最小长度：0 最大长度：500 |
permission |
PermissionClusterDetail object |
主机集群相关权限详情类 |
nick_name |
String |
创建人名称 |
env_count |
Integer |
环境数量 |
请求示例
https://{endpoint}/v1/resources/host-groups?project_id=5d091b14d7f54a139db644092fdc415c&page_index=1&page_size=10&sort_field=name&sort_type=ASC
响应示例
状态码： 200
OK 请求响应成功
{
"status" : "success",
"total" : 1,
"result" : [ {
"name" : "testwyk",
"description" : "11122211",
"os" : "linux",
"nick_name" : "AB边账号",
"id" : "ab7647b0863c4e969c8949d38d591339",
"project_id" : "6039d4480efc4dddb178abff98719913",
"permission" : {
"can_view" : true,
"can_edit" : true,
"can_delete" : true,
"can_add_host" : true,
"can_manage" : true
},
"created_by" : {
"user_id" : "6baa7454109d47c192f22078fe6cda20",
"user_name" : "devcloud_devcloud_l00490255_01"
},
"env_count" : 1,
"slave_cluster_id" : ""
} ]
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK 请求响应成功 |
错误码
请参见错误码。
