部署 CODEARTS DEPLOY-查询主机集群列表 (推荐):URI

时间:2024-11-21 15:38:07

URI

GET /v1/resources/host-groups

表1 Query参数

参数

是否必选

参数类型

描述

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查询使用官方资源池的主机集群列表。

默认取值

不涉及。

support.huaweicloud.com/api-deployman/ListHostClusters.html