Help Center/ CodeArts Deploy/ API Reference/ APIs/ Managing Host Clusters/ Querying a Host Cluster List (Recommended)
Updated on 2026-02-09 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying a Host Cluster List (Recommended)

Function

This API is used to query a host cluster list by specified criteria.

Calling Method

For details, see Calling APIs.

URI

GET /v1/resources/host-groups

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are supported.

Default value

N/A

name

No

String

Parameter description:

Keyword in the host cluster name.

Constraints:

N/A

Value range:

The value consists of 3-128 characters. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

Default value:

N/A

os

No

String

Parameter description:

OS of the host cluster.

Constraints:

N/A

Value range:

  • Windows: Windows OS.

  • Linux: Linux OS.

Default value:

N/A

page_index

No

Integer

Parameter description:

Page number for pagination query.

Constraints:

N/A

Value range:

1-2,147,483,647

Default value:

1

page_size

No

Integer

Parameter description:

Number of items displayed on each page.

Constraints:

N/A

Value range:

1-1,000

Default value:

1,000

sort_field

No

String

Parameter description:

Sorting field query.

Constraints:

N/A

Value range:

  • nick_name: Nickname.

  • name: Host cluster name.

Default value:

N/A

sort_type

No

String

Parameter description:

Sorting order.

Constraints:

N/A

Value range:

  • desc: Descending order.

  • asc: Ascending order.

Default value:

desc

is_proxy_mode

No

Integer

Definition

Whether the host cluster is in the agent mode.

Constraints

N/A

Range

  • 0: Non-agent-mode host cluster.

  • 1: Agent-mode host cluster.

Default value

N/A

slave_cluster_id

No

String

Definition

You can use the default value to query the list of host clusters in the default agent pool, and use the self-hosted agent pool ID to query the list of host clusters in the self-hosted agent pool.

Constraints

N/A

Range

Enter 32 characters of letters and digits. You can also use the default value to query the list of host clusters in the default agent pool.

Default value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition :

User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API used for Obtaining a User Token.

Constraints:

N/A.

Value range:

String. Max. 20,000 characters.

Default value:

N/A.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Parameter description:

Request success or failure status.

Value range:

  • success: Request succeeded

  • failed: Request failed

total

Integer

Parameter description:

Number of host clusters.

Value range:

0-1,000

result

Array of HostClusterInfo objects

Definition:

Host cluster list.
Table 4 HostClusterInfo

Parameter

Type

Description

id

String

Parameter description:

Host cluster ID.

Value range:

The value consists of 32 characters. Only letters and digits are allowed.

host_count

Integer

Parameter description:

Number of hosts in a cluster.

Value range:

0-200

name

String

Parameter description:

Host cluster name.

Value range:

The value consists of 3-128 characters. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

project_id

String

Definition

Project ID. For details, see Obtaining a Project ID.

Range

The value contains 32 characters. Only letters and digits are supported.

os

String

Parameter description:

OS of the host cluster.

Value range:

  • Windows: Windows OS.

  • Linux: Linux OS.

slave_cluster_id

String

Definition

Self-hosted agent pool ID.

Range

The value contains 32 characters, including letters and digits. The value can be empty.

description

String

Parameter description:

Host cluster description.

Value range:

The value is a string of 0 to 500 characters.

permission

PermissionClusterDetail object

Parameter description:

Operation permission matrix of the current user on the host cluster.

nick_name

String

Definition:

Nickname of the creator.

Value range:

String. 1 to 30 characters.

env_count

Integer

Parameter description:

Number of environments associated with a host cluster.

Value range:

0-200

is_proxy_mode

Integer

Definition

Whether the host cluster is in the agent mode.

Constraints

N/A

Range

  • 0: Non-agent-mode host cluster.

  • 1: Agent-mode host cluster.

Default value

N/A
Table 5 PermissionClusterDetail

Parameter

Type

Description

can_view

Boolean

Parameter description:

Whether a user has the view permission.

Value range:

  • true: With the view permission

  • false: Without the view permission

can_edit

Boolean

Parameter description:

Whether a user has the edit permission.

Value range:

  • true: With the edit permission

  • false: Without the edit permission

can_delete

Boolean

Parameter description:

Whether a user has the delete permission.

Value range:

  • true: With the delete permission

  • false: Without the delete permission

can_add_host

Boolean

Parameter description:

Whether a user has the permission to add hosts

Value range:

  • true: With the permission to add hosts

  • false: Without the permission to add hosts

can_manage

Boolean

Parameter description:

Whether a user has permission to manage the host cluster permission matrix

Value range:

  • true: With the permission to manage the host cluster permission matrix

  • false: Without the permission to manage the host cluster permission matrix

can_copy

Boolean

Parameter description:

Whether the user has permission to clone hosts.

Value range:

  • true: The user has permission to copy hosts.

  • false: The user does not have permission to copy hosts.

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,
      "can_copy" : true
    },
    "host_count" : 1,
    "env_count" : 1,
    "is_proxy_mode" : 1,
    "slave_cluster_id" : ""
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.codeartsdeploy.v2.region.CodeArtsDeployRegion;
import com.huaweicloud.sdk.codeartsdeploy.v2.*;
import com.huaweicloud.sdk.codeartsdeploy.v2.model.*;


public class ListHostClustersSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CodeArtsDeployClient client = CodeArtsDeployClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeArtsDeployRegion.valueOf("<YOUR REGION>"))
                .build();
        ListHostClustersRequest request = new ListHostClustersRequest();
        try {
            ListHostClustersResponse response = client.listHostClusters(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodeartsdeploy.v2.region.codeartsdeploy_region import CodeArtsDeployRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodeartsdeploy.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = CodeArtsDeployClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CodeArtsDeployRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListHostClustersRequest()
        response = client.list_host_clusters(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codeartsdeploy "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := codeartsdeploy.NewCodeArtsDeployClient(
        codeartsdeploy.CodeArtsDeployClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListHostClustersRequest{}
	response, err := client.ListHostClusters(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK: The request is successful.

Error Codes

See Error Codes.

Parent topic: Managing Host Clusters