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

Querying a Host List (Recommended)

Function

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

Calling Method

For details, see Calling APIs.

URI

GET /v1/resources/host-groups/{group_id}/hosts

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

group_id

Yes

String

Project ID

Minimum: 32

Maximum: 32

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

key_field

No

String

Fuzzy search information about the host name

Minimum: 1

Maximum: 256

environment_id

No

String

Environment ID

Minimum: 32

Maximum: 32

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_key

No

String

Sorting field: as_proxy|host_name|owner_name. 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

as_proxy

No

Boolean

Proxy or not

Request Parameters

Table 3 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 4 Response body parameters

Parameter

Type

Description

total

Integer

Host quantity

Minimum: 0

Maximum: 200

status

String

Request success or failure status

result

Array of HostInfo objects

Host information list

Array Length: 0 - 200

Table 5 HostInfo

Parameter

Type

Description

uuid

String

Host ID

ip

String

Host IP address

os

String

Host OS

port

Integer

Port

authorization

HostAuthorizationBody object

Log in to the host for authentication by password or key.

permission

PermissionHostDetailNew object

Host-related permission details

host_name

String

Host name

as_proxy

Boolean

Proxy or not

group_id

String

Host cluster ID

proxy_host_id

String

Proxy ID

owner_id

String

Host owner ID

owner_name

String

Host owner name

proxy_host

HostInfo object

Proxy details

connection_status

String

Connectivity status

create_time

String

Creation time

lastest_connection_time

String

Last connection time

connection_result

String

Connectivity verification result

nick_name

String

Host owner alias

import_status

String

Import status

env_count

Integer

Number of associated environments

Table 6 HostAuthorizationBody

Parameter

Type

Description

username

String

Username. The value can contain letters, digits, hyphens (-), underscores (_), and periods (.).

Minimum: 3

Maximum: 128

password

String

Password. When the authentication type is 0, the password is mandatory.

private_key

String

Key. When the authentication type is 1, the key is mandatory.

Minimum: 1

Maximum: 5000

trusted_type

Integer

Authentication type. 0 indicates password authentication, and 1 indicates key authentication.

Enumeration values:

  • 0

  • 1

Table 7 PermissionHostDetailNew

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_copy

Boolean

Whether you have the permission to clone hosts

Example Requests

https://{endpoint}/v1/resources/host-groups/317aea99cf2944fcacf88b34ef771843/hosts?page_index=1&page_size=10&sort_key=host_name&sort_dir=ASC&as_proxy=false

Example Responses

Status code: 200

OK: The request is successful.

{
  "result" : [ {
    "host_name" : "100.101.28.203",
    "ip" : "100.101.28.203",
    "port" : 22,
    "os" : "linux",
    "authorization" : {
      "username" : "root",
      "password" : null,
      "private_key" : null,
      "trusted_type" : 0
    },
    "permission" : {
      "can_view" : true,
      "can_edit" : true,
      "can_delete" : true,
      "can_add_host" : true,
      "can_copy" : true
    },
    "uuid" : "2cc913cc9a494f09b7320801ebacad02",
    "group_id" : "ab7647b0863c4e969c8949d38d591339",
    "as_proxy" : false,
    "proxy_host_id" : "",
    "owner_id" : "6baa7454109d47c192f22078fe6cda20",
    "owner_name" : "devcloud_devcloud_l00490255_01",
    "connection_status" : "success",
    "create_time" : "2021-04-15 11:01:51",
    "connection_result" : "Connection established",
    "lastest_connection_time" : "2021-04-15 11:02:00",
    "nick_name" : "A/B Side Account",
    "proxy_host" : null,
    "import_status" : null,
    "env_count" : 1
  } ],
  "total" : 1,
  "status" : "success"
}

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

    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();
        ListNewHostsRequest request = new ListNewHostsRequest();
        request.withKeyField("<key_field>");
        request.withEnvironmentId("<environment_id>");
        request.withPageIndex(<page_index>);
        request.withPageSize(<page_size>);
        request.withSortKey("<sort_key>");
        request.withSortDir(ListNewHostsRequest.SortDirEnum.fromValue("<sort_dir>"));
        request.withAsProxy(<as_proxy>);
        try {
            ListNewHostsResponse response = client.listNewHosts(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
# 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 = ListNewHostsRequest()
        request.key_field = "<key_field>"
        request.environment_id = "<environment_id>"
        request.page_index = <page_index>
        request.page_size = <page_size>
        request.sort_key = "<sort_key>"
        request.sort_dir = "<sort_dir>"
        request.as_proxy = <AsProxy>
        response = client.list_new_hosts(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.ListNewHostsRequest{}
	keyFieldRequest:= "<key_field>"
	request.KeyField = &keyFieldRequest
	environmentIdRequest:= "<environment_id>"
	request.EnvironmentId = &environmentIdRequest
	pageIndexRequest:= int32(<page_index>)
	request.PageIndex = &pageIndexRequest
	pageSizeRequest:= int32(<page_size>)
	request.PageSize = &pageSizeRequest
	sortKeyRequest:= "<sort_key>"
	request.SortKey = &sortKeyRequest
	sortDirRequest:= model.GetListNewHostsRequestSortDirEnum().<SORT_DIR>
	request.SortDir = &sortDirRequest
	asProxyRequest:= <as_proxy>
	request.AsProxy = &asProxyRequest
	response, err := client.ListNewHosts(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.