Updated on 2024-07-05 GMT+08:00

Querying a Host Cluster List

Function

This API is used to query a host cluster list by specified criteria. This API will not be maintained after September 30, 2024. You can use the ListHostClusters API instead.

Calling Method

For details, see Calling APIs.

URI

GET /v2/host-groups

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

project_id

No

String

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

Minimum: 32

Maximum: 32

region_name

Yes

String

Region information

Minimum: 1

Maximum: 256

os

No

String

Operating system: Windows or Linux

Enumeration values:

  • windows

  • linux

offset

No

Integer

Offset, which is the position where the query starts. The value must be no less than 0.

Minimum: 0

limit

No

Integer

Number of items displayed on each page. The default value is 1,000.

Minimum: 1

Maximum: 1000

name

No

String

Host cluster name

Minimum: 3

Maximum: 128

sort_key

No

String

Sorting field: nickName|NAME|OWNER_NAME|CREATE_TIME|name|owner_name|create_time. If this parameter is left blank, the default sorting mode is used.

sort_dir

No

String

Sorting mode: DESC (default) and ASC.

Enumeration values:

  • DESC

  • ASC

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

total

Integer

Number of host clusters

Minimum: 0

Maximum: 1000

host_groups

Array of DeploymentGroupDetail objects

Response body of host cluster details

Array Length: 0 - 1000

Table 4 DeploymentGroupDetail

Parameter

Type

Description

group_id

String

Host cluster ID

Minimum: 32

Maximum: 32

created_time

String

Creation time

updated_time

String

Modification time

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

project_name

String

Project name

Minimum: 3

Maximum: 128

name

String

Host cluster name

region_name

String

Region information

project_id

String

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

os

String

Operating system: Windows or Linux

auto_connection_test_switch

Integer

The automatic test function has been removed. This field is invalid.

Enumeration values:

  • 0

  • 1

  • 2

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.

nick_name

String

Alias

created_by

UserInfo object

User information

updated_by

UserInfo object

User information

description

String

Description

Minimum: 0

Maximum: 500

permission

PermissionGroupDetail object

Host cluster permission details

Table 5 UserInfo

Parameter

Type

Description

user_id

String

User ID

user_name

String

Username

Table 6 PermissionGroupDetail

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}/v2/host-groups?region_name=cn-north-7&project_id=6039d4480efc4dddb178abff98719913&offset=1&limit=10&sort_key=create_time&sort_dir=DESC

Example Responses

Status code: 200

OK: The request is successful.

{
  "total" : 1,
  "host_groups" : [ {
    "name" : "testwyk",
    "description" : "11122211",
    "os" : "linux",
    "nick_name" : "A/B Side Account",
    "group_id" : "ab7647b0863c4e969c8949d38d591339",
    "region_name" : "cn-north-7",
    "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"
    },
    "updated_by" : {
      "user_id" : "6baa7454109d47c192f22078fe6cda20",
      "user_name" : "devcloud_devcloud_l00490255_01"
    },
    "auto_connection_test_switch" : 0,
    "slave_cluster_id" : "",
    "created_time" : "2021-04-01 17:05:53",
    "updated_time" : "2021-04-21 14:29:14",
    "host_count" : 1,
    "project_name" : null
  } ]
}

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
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 ListHostGroupsSolution {

    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();
        ListHostGroupsRequest request = new ListHostGroupsRequest();
        request.withProjectId("<project_id>");
        request.withRegionName("<region_name>");
        request.withOs(ListHostGroupsRequest.OsEnum.fromValue("<os>"));
        request.withOffset(<offset>);
        request.withLimit(<limit>);
        request.withName("<name>");
        request.withSortKey("<sort_key>");
        request.withSortDir(ListHostGroupsRequest.SortDirEnum.fromValue("<sort_dir>"));
        try {
            ListHostGroupsResponse response = client.listHostGroups(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
# 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 = ListHostGroupsRequest()
        request.project_id = "<project_id>"
        request.region_name = "<region_name>"
        request.os = "<os>"
        request.offset = <offset>
        request.limit = <limit>
        request.name = "<name>"
        request.sort_key = "<sort_key>"
        request.sort_dir = "<sort_dir>"
        response = client.list_host_groups(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
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.ListHostGroupsRequest{}
	request.ProjectId = "<project_id>"
	request.RegionName = "<region_name>"
	osRequest:= model.GetListHostGroupsRequestOsEnum().<OS>
	request.Os = &osRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	nameRequest:= "<name>"
	request.Name = &nameRequest
	sortKeyRequest:= "<sort_key>"
	request.SortKey = &sortKeyRequest
	sortDirRequest:= model.GetListHostGroupsRequestSortDirEnum().<SORT_DIR>
	request.SortDir = &sortDirRequest
	response, err := client.ListHostGroups(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.