更新时间:2021-11-16 GMT+08:00
分享

查询主机列表

功能介绍

根据主机组id查询指定主机组下的主机列表。

调试

您可以在API Explorer中调试该接口。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

group_id

String

主机组id

表2 Query参数

参数

是否必选

参数类型

描述

as_proxy

Boolean

是否为代理机

offset

Integer

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

最小值:0

limit

Integer

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

最小值:1

最大值:1000

name

String

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

最小长度:3

最大长度:128

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

  • desc

  • asc

with_auth

Boolean

返回结果是否加密

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:0

最大长度:20000

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

主机数量

最小值:0

最大值:200

group_name

String

主机组名称

最小长度:3

最大长度:128

hosts

Array of DeploymentHostDetail objects

主机列表信息

表5 DeploymentHostDetail

参数

参数类型

描述

group_id

String

主机组id

最小长度:32

最大长度:32

host_name

String

主机名称

最小长度:3

最大长度:128

ip

String

IP,请输入弹性ip格式:161.17.101.12

port

Integer

ssh端口,如:22

os

String

操作系统:windows|linux,需要和主机组保持一致

枚举值:

  • 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

主机组名

最小长度:3

最大长度:128

project_id

String

devcloud项目id

project_name

String

devcloud项目名称

最小长度:3

最大长度:128

permission

PermissionHostDetail object

主机相关权限详情类

表6 DeploymentHostAuthorizationBody

参数

参数类型

描述

username

String

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

最小长度:3

最大长度:128

password

String

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

private_key

String

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

最小长度:1

最大长度:5000

trusted_type

Integer

认证类型,0表示使用密码认证,1表示使用密钥认证

枚举值:

  • 0

  • 1

表7 PermissionHostDetail

参数

参数类型

描述

can_view

Boolean

是否有查看权限

can_edit

Boolean

是否有编辑权限

can_delete

Boolean

是否有删除权限

can_add_host

Boolean

是否有添加主机权限

can_connection_test

Boolean

是否测试主机连通性权限

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 403

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

请求示例

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

响应示例

状态码: 200

OK

{
  "hosts" : [ {
    "hostname" : "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
    },
    "nickName" : "AB边账号",
    "id" : 200001149,
    "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"
}

状态码: 400

Bad Request

{
  "error_code" : "Deploy.00021104",
  "error_msg" : "The host group does not exist."
}

状态码: 401

Unauthorized

{
  "error_code" : "Deploy.00021203",
  "error_msg" : "Insufficient permissions."
}

状态码: 403

Forbidden

{
  "error_code" : "Deploy.00021203",
  "error_msg" : "Insufficient permissions."
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

错误码

请参见错误码

分享:

    相关文档

    相关产品

close