文档首页/ 部署 CodeArts Deploy/ API参考/ API/ 环境管理/ 查询环境内的主机列表
更新时间：2024-06-28 GMT+08:00
在线调试
CLI示例
查看PDF

查询环境内的主机列表

功能介绍

查询环境内的主机列表。

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

application_id

是

String

应用id

最小长度：32

最大长度：32

environment_id

是

String

环境id

最小长度：32

最大长度：32
表2 Query参数

参数

是否必选

参数类型

描述

key_field

否

String

主机名、ip关键字模糊搜索

最小长度：0

最大长度：128

as_proxy

否

Boolean

是否为代理机,true为代理机

page_index

否

Integer

分页页码

最小值：1

最大值：2147483647

page_size

否

Integer

分页查询每页条数

最小值：1

最大值：100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

最小长度：0

最大长度：20000

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

status

String

请求成功失败状态

total

Integer

总数量

result

Array of EnvironmentHostInfo objects

环境下主机信息列表
表5 EnvironmentHostInfo

参数

参数类型

描述

host_id

String

主机id

ip

String

主机ip，如：161.17.101.12

port

Integer

ssh端口，如：22

permission

EnvironmentHostPermission object

环境权限详情

group_id

String

主机集群id

host_name

String

主机名

as_proxy

Boolean

是否为代理机

proxy_host_id

String

代理机id

proxy_host_name

String

代理机名称

owner_id

String

主机所属人id

owner_name

String

主机所属人名称

connection_status

String

连通性状态

lastest_connection_time

String

上次连通时间

connection_result

String

连通性验证结果

nick_name

String

创建人昵称
表6 EnvironmentHostPermission

参数

参数类型

描述

can_delete

Boolean

是否有删除权限

can_deploy

Boolean

是否有部署权限

can_edit

Boolean

是否有编辑权限

can_manage

Boolean

是否有权限管理权限

can_view

Boolean

是否有查看权限

请求示例

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

响应示例

状态码： 200

OK 请求响应成功

{
  "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" : "连接失败",
    "lastest_connection_time" : "2024-05-31 14:47:52"
  } ],
  "total" : 1
}

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码。

父主题： 环境管理