部署 CODEARTS DEPLOY-查询主机列表:响应参数

时间:2024-04-10 16:24:46

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

主机数量

最小值:0

最大值:200

group_name

String

主机集群名称

最小长度:3

最大长度:128

hosts

Array of DeploymentHostDetail objects

主机列表信息

数组长度:0 - 200

表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

项目ID,获取方式请参见获取项目ID

project_name

String

项目名称

最小长度:3

最大长度:128

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

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

最小长度: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

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

support.huaweicloud.com/api-deployman/ListHosts.html