查询主机集群列表 （推荐）

project_id

是

String

参数解释：

项目id，获取方式请参见获取项目id。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

name

否

String

参数解释：

主机集群名称中的关键字。

约束限制：

不涉及。

取值范围：

只能由中文字符、英文字母、数字及"-"、"_"、"."组成，且长度为[3-128]个字符。

默认取值：

不涉及。

os

否

String

参数解释：

主机集群的操作系统类型。

约束限制：

不涉及。

取值范围：

• windows：windows操作系统类型。

• linux：linux操作系统类型。

默认取值：

不涉及。

page_index

否

Integer

参数解释：

分页查询页码数。

约束限制：

不涉及。

取值范围：

1-2147483647

默认取值：

1

page_size

否

Integer

参数解释：

分页查询每页显示的条目数量。

约束限制：

不涉及。

取值范围：

1-1000

默认取值：

1000

sort_field

否

String

参数解释：

查询排序字段。

约束限制：

不涉及。

取值范围：

• nick_name：用户昵称。

• name：主机集群名称。

默认取值：

不涉及。

sort_type

否

String

参数解释：

排序方式。

约束限制：

不涉及。

取值范围：

• desc：降序排列。

• asc：升序排列。

默认取值：

desc

is_proxy_mode

否

Integer

参数解释：

是否为代理模式主机集群。

约束限制：

不涉及。

取值范围：

• 0：非代理模式主机集群。

• 1：代理模式主机集群。

默认取值：

不涉及。

slave_cluster_id

否

String

参数解释：

传default查询使用默认资源池主机集群列表，传自定义资源池id查询使用该自定义资源池的主机集群列表。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符，或传default查询使用默认资源池的主机集群列表。

默认取值：

不涉及。

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及。

取值范围：

字符串，长度不超过20000个字符。

默认取值：

不涉及。

status

String

参数解释：

请求成功、失败状态。

取值范围：

• success：请求成功。

• failed：请求失败。

total

Integer

参数解释：

主机集群个数。

取值范围：

0-1000

result

Array of HostClusterInfo objects

参数解释：

主机集群列表。

id

String

参数解释：

主机集群id。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

host_count

Integer

参数解释：

集群内主机数量。

取值范围：

0-200

name

String

参数解释：

主机集群名称。

取值范围：

只能由中文字符、英文字母、数字及"-"、"_"、"."组成，且长度为[3-128]个字符。

project_id

String

参数解释：

项目id，获取方式请参见获取项目id。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

os

String

参数解释：

主机集群的操作系统类型。

取值范围：

• windows：windows操作系统类型。

• linux：linux操作系统类型。

slave_cluster_id

String

参数解释：

自定义资源池id。

取值范围：

只能由英文字母、数字组成，且长度为32个字符，或值为空

description

String

参数解释：

主机集群描述信息。

取值范围：

字符串，长度为[0-500]个字符。

permission

PermissionClusterDetail object

参数解释：

当前用户对主机集群的操作权限矩阵。

nick_name

String

参数解释：

创建者用户昵称。

取值范围：

字符串，长度为[1-30]个字符。

env_count

Integer

参数解释：

主机集群关联环境数量。

取值范围：

0-200

is_proxy_mode

Integer

参数解释：

是否为代理模式主机集群。

约束限制：

不涉及。

取值范围：

• 0：非代理模式主机集群。

• 1：代理模式主机集群。

默认取值：

不涉及。

can_view

Boolean

参数解释：

是否有查看权限。

取值范围：

• true：有查看权限。

• false：无查看权限。

can_edit

Boolean

参数解释：

是否有编辑权限。

取值范围：

• true：有编辑权限。

• false：无编辑权限。

can_delete

Boolean

参数解释：

是否有删除权限。

取值范围：

• true：有删除权限。

• false：无删除权限。

can_add_host

Boolean

参数解释：

是否有添加主机权限。

取值范围：

• true：有添加主机权限。

• false：无添加主机权限。

can_manage

Boolean

参数解释：

是否有管理主机集群权限矩阵的权限。

取值范围：

• true：有管理主机集群权限矩阵的权限。

• false：无管理主机集群权限矩阵的权限。

can_copy

Boolean

参数解释：

是否有复制主机的权限。

取值范围：

• true：有复制主机的权限。

• false：无复制主机的权限。

200

OK 请求响应成功