Querying a Host Cluster List (Recommended)

Function

This API is used to query the host cluster list by conditions.

URI

GET /v1/resources/host-groups

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. Minimum: 32 Maximum: 32
name	No	String	Fuzzy search information about the host cluster. Minimum: 1 Maximum: 256
os	No	String	Operating system: windows and linux. Enumeration values: windows linux
page_index	No	Integer	Page number. Minimum: 0
page_size	No	Integer	Number of items displayed on each page. The default value is 10. Minimum: 1 Maximum: 1000
sort_field	No	String	Sorting field: nick_name\|name\|owner_name\|create_time. If this parameter is left blank, the default sorting mode is used.
sort_type	No	String	Sorting mode: DESC and ASC. The default value is DESC. Enumeration values: DESC ASC
is_proxy_mode	No	Integer	Whether a proxy host is used.
slave_cluster_id	No	String	Custom resource pool ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. Minimum: 0 Maximum: 20000

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
status	String	Request status.
total	Integer	Number of host clusters. Minimum: 0 Maximum: 1000
result	Array of HostClusterInfo objects	Response body of host cluster details. Array Length: 0 - 1000

**Table 4** HostClusterInfo
Parameter	Type	Description
id	String	Host cluster ID. Minimum: 32 Maximum: 32
host_count	Integer	Number of hosts in a cluster. A maximum of 200 hosts can be added to a host cluster. Minimum: 0 Maximum: 200
name	String	Host cluster name.
project_id	String	Project ID. For details, see Obtaining a Project ID.
os	String	Operating system: windows and linux.
slave_cluster_id	String	Slave cluster ID. If the value is null, the default slave cluster is used. If slave is user-defined, the slave cluster ID is used.
created_by	UserInfo object	User information.
description	String	Description. Minimum: 0 Maximum: 500
permission	PermissionClusterDetail object	Host cluster permission details.
nick_name	String	Creator name.
env_count	Integer	Number of environments.

**Table 5** UserInfo
Parameter	Type	Description
user_id	String	User ID.
user_name	String	Username.

**Table 6** PermissionClusterDetail
Parameter	Type	Description
can_view	Boolean	Whether you have the view permission.
can_edit	Boolean	Whether you have the edit permission.
can_delete	Boolean	Whether you have the deletion permission.
can_add_host	Boolean	Whether you have the permission to add hosts.
can_manage	Boolean	Whether you have permission to edit the host cluster permission matrix.

Example Requests

https://{endpoint}/v1/resources/host-groups?project_id=5d091b14d7f54a139db644092fdc415c&page_index=1&page_size=10&sort_field=name&sort_type=ASC

Example Responses

Status code: 200

OK: The request is successful.

{
  "status" : "success",
  "total" : 1,
  "result" : [ {
    "name" : "testwyk",
    "description" : "11122211",
    "os" : "linux",
    "nick_name" : "A-B Side Account",
    "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" : ""
  } ]
}