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

查询主机列表

功能介绍

根据主机集群id查询指定主机集群下的主机列表。该接口于2024年09月30日后不再维护，推荐使用新版查询主机列表（ListNewHosts）接口。

调用方法

请参见如何调用API。

URI

GET /v2/host-groups/{group_id}/hosts

表1 路径参数

参数

是否必选

参数类型

描述

group_id

是

String

主机集群id
表2 Query参数

参数

是否必选

参数类型

描述

as_proxy

否

Boolean

是否为代理机

offset

否

Integer

偏移量，表示从此偏移量开始查询，offset大于等于0

limit

否

Integer

每页显示的条目数量，默认为1000

name

否

String

主机名，可输入中英文，数字和符号(-_.)

sort_key

否

String

排序字段，支持：AS_PROXY|HOST_NAME|OS|OWNER_NAME|as_proxy|host_name|os|owner_name|nickName。不填默认为：as_proxy

sort_dir

否

String

排序方式,默认为：DESC。DESC：降序排序。ASC：升序排序

with_auth

否

Boolean

返回结果是否加密

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

主机数量

group_name

String

主机集群名称

hosts

Array of DeploymentHostDetail objects

主机列表信息
表5 DeploymentHostDetail

参数

参数类型

描述

group_id

String

主机集群id

host_name

String

主机名称

ip

String

IPv4/IPv6格式的IP地址

port

Integer

ssh端口，如：22

os

String

操作系统：windows|linux，需要和主机集群保持一致

as_proxy

Boolean

是否为代理机

proxy_host_id

String

代理机id

authorization

DeploymentHostAuthorizationBody object

登录主机鉴权，使用密码登录则填写密码即可，使用密钥则填写密钥，二选一即可。

install_icagent

Boolean

免费启用应用运维服务（AOM），提供指标监控、日志查询、告警功能（自动安装数据采集器 ICAgent，仅支持华为云linux主机）

host_id

String

主机id

proxy_host

DeploymentHostDetail object

代理机信息详情

group_name

String

主机集群名

project_id

String

项目id，获取方式请参见获取项目id。

project_name

String

项目名称

permission

PermissionHostDetail object

主机相关权限详情类

update_time

String

更新时间

lastest_connection_time

String

最后连接时间

connection_status

String

连接状态

owner_name

String

拥有者名称

updator_id

String

维护者id

create_time

String

创建时间

nick_name

String

昵称

owner_id

String

拥有者id

updator_name

String

维护者名称

connection_result

String

连接结果
表6 DeploymentHostAuthorizationBody

参数

参数类型

描述

username

String

用户名，可输入中英文，数字和符号(-_.)。

password

String

密码，认证类型为0时，密码必填。

private_key

String

密钥，认证类型为1时，密钥必填

trusted_type

Integer

认证类型，0表示使用密码认证，1表示使用密钥认证
表7 PermissionHostDetail

参数

参数类型

描述

can_view

Boolean

是否有查看权限

can_edit

Boolean

是否有编辑权限

can_delete

Boolean

是否有删除权限

can_add_host

Boolean

是否有添加主机权限

can_connection_test

Boolean

是否有测试主机连通性权限

请求示例

https://{endpoint}/v2/host-groups/ab7647b0863c4e969c8949d38d591339/hosts?offset=0&limit=10&sort_key=AS_PROXY&sort_dir=asc&with_auth=false

响应示例

状态码： 200

OK 请求响应成功

{
  "hosts" : [ {
    "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_connection_test" : true
    },
    "host_id" : "2cc913cc9a494f09b7320801ebacad02",
    "group_id" : "ab7647b0863c4e969c8949d38d591339",
    "as_proxy" : false,
    "proxy_host_id" : null,
    "owner_id" : "6baa7454109d47c192f22078fe6cda20",
    "owner_name" : "devcloud_devcloud_l00490255_01",
    "updator_id" : "6baa7454109d47c192f22078fe6cda20",
    "updator_name" : "devcloud_devcloud_l00490255_01",
    "connection_status" : "success",
    "install_icagent" : false,
    "create_time" : "2021-04-15 11:01:51",
    "update_time" : "2021-04-21 15:04:24",
    "connection_result" : "连接成功",
    "lastest_connection_time" : "2021-04-15 11:02:00",
    "nick_name" : "AB边账号",
    "proxy_host" : null,
    "group_name" : null,
    "project_id" : "6039d4480efc4dddb178abff98719913",
    "project_name" : null
  } ],
  "total" : 1,
  "group_name" : "test"
}

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码。

父主题： 主机管理