Help Center> CodeArts Deploy> API Reference> APIs> Managing Host Clusters> Querying a Host Cluster List (Recommended)
Updated on 2024-07-05 GMT+08:00

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

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 or 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 (default) and ASC.

Enumeration values:

  • DESC

  • ASC

is_proxy_mode

No

Integer

Proxy or not

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 success or failure 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 or 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 delete 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" : ""
  } ]
}

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
46
47
48
49
50
51
52
53
54
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();
        request.withProjectId("<project_id>");
        request.withName("<name>");
        request.withOs(ListHostClustersRequest.OsEnum.fromValue("<os>"));
        request.withPageIndex(<page_index>);
        request.withPageSize(<page_size>);
        request.withSortField("<sort_field>");
        request.withSortType(ListHostClustersRequest.SortTypeEnum.fromValue("<sort_type>"));
        request.withIsProxyMode(<is_proxy_mode>);
        request.withSlaveClusterId("<slave_cluster_id>");
        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
31
32
33
34
35
36
37
38
39
# 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()
        request.project_id = "<project_id>"
        request.name = "<name>"
        request.os = "<os>"
        request.page_index = <page_index>
        request.page_size = <page_size>
        request.sort_field = "<sort_field>"
        request.sort_type = "<sort_type>"
        request.is_proxy_mode = <is_proxy_mode>
        request.slave_cluster_id = "<slave_cluster_id>"
        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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
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{}
	request.ProjectId = "<project_id>"
	nameRequest:= "<name>"
	request.Name = &nameRequest
	osRequest:= model.GetListHostClustersRequestOsEnum().<OS>
	request.Os = &osRequest
	pageIndexRequest:= int32(<page_index>)
	request.PageIndex = &pageIndexRequest
	pageSizeRequest:= int32(<page_size>)
	request.PageSize = &pageSizeRequest
	sortFieldRequest:= "<sort_field>"
	request.SortField = &sortFieldRequest
	sortTypeRequest:= model.GetListHostClustersRequestSortTypeEnum().<SORT_TYPE>
	request.SortType = &sortTypeRequest
	isProxyModeRequest:= int32(<is_proxy_mode>)
	request.IsProxyMode = &isProxyModeRequest
	slaveClusterIdRequest:= "<slave_cluster_id>"
	request.SlaveClusterId = &slaveClusterIdRequest
	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.