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 for. 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"
}