Help Center/ CodeArts Deploy/ API Reference/ APIs/ Managing Hosts/ Querying Host Details (Recommended)
Updated on 2025-08-18 GMT+08:00

Querying Host Details (Recommended)

Function

This API is used to query host details by ID.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

group_id

Yes

String

Definition:

Host cluster ID.

Constraints:

N/A.

Value range:

32 characters, including letters and digits.

Default value:

N/A.

host_id

Yes

String

Definition:

Host ID.

Constraints:

N/A.

Value range:

32 characters, including letters and digits.

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 forObtaining 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

Definition:

Request status (successful or failed).

Value range:

  • success: Successful.

  • failed: Failed.

result

HostInfoDetail object

Definition:

Host details.

Table 4 HostInfoDetail

Parameter

Type

Description

host_id

String

Definition:

Host ID.

Value range:

32 characters, including letters and digits.

ip

String

Definition:

Host IP address.

Value range:

N/A.

os

String

Definition:

OS of hosts.

Value range:

  • window: Windows OS.

  • linux: Linux OS.

port

Integer

Definition:

Port.

Value range:

0–65535.

authorization

HostAuthorizationBody object

Definition:

Log in to the host for authentication. Use either a password or key for login.

permission

PermissionHostDetailNew object

Parameter description:

Operation permission matrix of the current user on the host.

group_id

String

Definition:

Host cluster ID.

Value range:

32 characters, including letters and digits.

host_name

String

Definition:

Host name.

Value range:

3 to 128 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).

as_proxy

Boolean

Definition:

Agent or not.

Value range:

  • true: Yes.

  • false: No.

proxy_host_id

String

Definition:

Agent host ID.

Value range:

32 characters, including letters and digits.

owner_name

String

Definition:

Creator username.

Value range:

Max. 255 characters, including letters, digits, and underscores (_).

proxy_host

HostInfoDetail object

Definition:

Agent details.

connection_status

String

Definition:

Connectivity status.

Value range:

  • success: The connectivity is successful.

  • failed: The connectivity fails.

create_time

String

Definition:

Creation time. Format: yyyy-MM-dd HH:mm:ss. Example: 2025-04-21 17:05:53.

Value range:

N/A.

update_time

String

Definition:

Update time. Format: yyyy-MM-dd HH:mm:ss. Example: 2025-04-21 17:05:53.

Value range:

N/A.

lastest_connection_time

String

Definition:

Last host connectivity verification time. Format: yyyy-MM-dd HH:mm:ss. Example: 2025-04-21 17:05:53.

Value range:

N/A.

connection_result

String

Definition:

Connectivity verification result.

Value range:

N/A.

install_icagent

Boolean

Definition:

ICAgent installation status.

Value range:

  • true: Installed.

  • false: Not installed.

nick_name

String

Definition:

Nickname of the creator.

Value range:

String. 1 to 30 characters.

Table 5 HostAuthorizationBody

Parameter

Type

Description

username

String

Definition:

Username for logging in to the host.

Value range:

1 to 31 characters, including letters, digits, underscores (_), hyphens (-), periods (.), and at signs (@).

password

String

Definition:

Password. Mandatory when the authentication type is 0.

Value range:

5 to 32 characters. Spaces, newline characters, carriage return characters, tab characters, double quotation marks, and single quotation marks are not supported.

private_key

String

Definition:

Key. Mandatory when the authentication type is 1.

Value range:

Max. 5,000 characters.

trusted_type

Integer

Definition:

Authentication type for logging in to the host.

Value range:

  • 0: Password authentication.

  • 1: Key authentication.

Table 6 PermissionHostDetailNew

Parameter

Type

Description

can_view

Boolean

Definition:

Whether you have the view permission.

Value range:

  • true: Yes.

  • false: No.

can_edit

Boolean

Definition:

Whether you have the edit permission.

Value range:

  • true: Yes.

  • false: No.

can_delete

Boolean

Definition:

Whether you have the delete permission.

Value range:

  • true: Yes.

  • false: No.

can_add_host

Boolean

Definition:

Whether you have permission to add hosts.

Value range:

  • true: Yes.

  • false: No.

can_copy

Boolean

Definition:

Whether you have permission to clone hosts.

Value range:

  • true: Yes.

  • false: No.

Example Requests

https://{endpoint}/v1/resources/host-groups/ab7647b0863c4e969c8949d38d591339/hosts/300d6d2e53624d0da08b182099ad10f7

Example Responses

Status code: 200

OK: The request is successful.

{
  "result" : {
    "host_id" : "300d6d2e53624d0da08b182099ad10f7",
    "ip" : "100.101.28.215",
    "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
    },
    "group_id" : "ab7647b0863c4e969c8949d38d591339",
    "host_name" : "100.101.28.215",
    "as_proxy" : false,
    "proxy_host_id" : null,
    "owner_name" : "devcloud_devcloud_l00490255_01",
    "proxy_host" : null,
    "connection_status" : "success",
    "install_icagent" : false,
    "create_time" : "2021-05-13 09:35:41",
    "update_time" : "2021-05-13 09:35:41",
    "connection_result" : "Connection established",
    "lastest_connection_time" : "2021-05-13 09:36:11",
    "nick_name" : "A/B Side Account"
  },
  "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
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 ShowHostDetailSolution {

    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();
        ShowHostDetailRequest request = new ShowHostDetailRequest();
        request.withGroupId("{group_id}");
        request.withHostId("{host_id}");
        try {
            ShowHostDetailResponse response = client.showHostDetail(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
# 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 = ShowHostDetailRequest()
        request.group_id = "{group_id}"
        request.host_id = "{host_id}"
        response = client.show_host_detail(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
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.ShowHostDetailRequest{}
	request.GroupId = "{group_id}"
	request.HostId = "{host_id}"
	response, err := client.ShowHostDetail(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.