Help Center/ CodeArts Deploy/ API Reference/ APIs/ Managing Environments/ Querying a Host List in an Environment
Updated on 2025-05-27 GMT+08:00
View PDF

Querying a Host List in an Environment

Function

This API is used to query a host list in an environment.

Calling Method

For details, see Calling APIs.

URI

GET /v1/applications/{application_id}/environments/{environment_id}/hosts

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

application_id

Yes

String

Application ID

environment_id

Yes

String

Environment ID
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

key_field

No

String

Fuzzy search by host name and IP address

as_proxy

No

Boolean

Proxy or not. true: Proxy.

page_index

No

Integer

Page number

page_size

No

Integer

Number of records on each page

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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

status

String

Request success or failure status

total

Integer

Total quantity

result

Array of EnvironmentHostInfo objects

Host information list in the environment
Table 5 EnvironmentHostInfo

Parameter

Type

Description

host_id

String

Host ID

ip

String

Host IP address, for example, 161.17.101.12.

port

Integer

SSH Port, for example, 22.

permission

EnvironmentHostPermission object

Environment permission details

group_id

String

Host cluster ID

host_name

String

Host name

as_proxy

Boolean

Proxy or not

proxy_host_id

String

Proxy ID

proxy_host_name

String

Proxy name

owner_id

String

Host owner ID

owner_name

String

Host owner name

connection_status

String

Connectivity status

lastest_connection_time

String

Last connection time

connection_result

String

Connectivity verification result

nick_name

String

Creator alias
Table 6 EnvironmentHostPermission

Parameter

Type

Description

can_delete

Boolean

Whether you have the delete permission

can_deploy

Boolean

Whether you have the deploy permission

can_edit

Boolean

Whether you have the edit permission

can_manage

Boolean

Whether you can manage permissions

can_view

Boolean

Whether you have the view permission

Example Requests

https://{endpoint}/v1/applications/e1d7b7388b4641e2a027f5673fd6093b/environments/82c4eb8c522d42969a3da30123e1ecba/hosts?page_index=1&page_size=10&key_field=

Example Responses

Status code: 200

OK: The request is successful.

{
  "status" : "success",
  "result" : [ {
    "ip" : "100.85.172.31",
    "port" : 22,
    "permission" : {
      "can_view" : true,
      "can_edit" : true,
      "can_delete" : true,
      "can_deploy" : true,
      "can_manage" : true
    },
    "host_id" : "13c208e61c9541ab9895f450fd1cbf7c",
    "host_name" : "test",
    "as_proxy" : false,
    "group_id" : "2a8c2da888c04a5eaff10d0787c90ea4",
    "proxy_host_id" : "",
    "proxy_host_name" : null,
    "owner_id" : "6baa7454109d47c192f22078fe6cda20",
    "owner_name" : "devcloud_devcloud_l00490255_01",
    "nick_name" : "devcloud_devcloud_l00490255_01",
    "connection_status" : "failed",
    "connection_result" : "Connection failed",
    "lastest_connection_time" : "2024-05-31 14:47:52"
  } ],
  "total" : 1
}

Status Codes

Status Code

Description

200

OK: The request is successful.

Error Codes

See Error Codes.

Parent topic: Managing Environments