更新时间:2025-12-25 GMT+08:00

查询主机详情 (推荐)

功能介绍

根据主机id查询主机详情。

调用方法

请参见如何调用API

URI

GET /v1/resources/host-groups/{group_id}/hosts/{host_id}

表1 路径参数

参数

是否必选

参数类型

描述

group_id

String

参数解释

主机集群id。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

host_id

String

参数解释

主机id。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

约束限制

不涉及。

取值范围

字符串,长度不超过20000个字符。

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释

请求成功、失败状态。

取值范围

  • success:请求成功。

  • failed:请求失败。

result

HostInfoDetail object

参数解释

主机详情信息。

表4 HostInfoDetail

参数

参数类型

描述

host_id

String

参数解释

主机id。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

ip

String

参数解释

主机IP。

取值范围

不涉及。

os

String

参数解释

主机的操作系统类型。

取值范围

  • windows:windows操作系统类型。

  • linux:linux操作系统类型。

port

Integer

参数解释

端口号。

取值范围

0-65535。

authorization

HostAuthorizationBody object

参数解释

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

permission

PermissionHostDetailNew object

参数解释

当前用户对主机的操作权限矩阵。

group_id

String

参数解释

主机集群id。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

host_name

String

参数解释

主机名称。

取值范围

只能由中文字符、英文字母、数字及"-"、"_"、"."组成,且长度为[3-128]个字符。

as_proxy

Boolean

参数解释

是否是代理机。

取值范围

  • true:是代理机。

  • false:非代理机。

proxy_host_id

String

参数解释

代理主机id。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

owner_name

String

参数解释

创建者用户名称。

取值范围

只能由英文字母、数字及_组成,最大长度不超过255字符。

proxy_host

HostInfoDetail object

参数解释

代理机信息详情。

connection_status

String

参数解释

连通性状态。

取值范围

  • success:连接成功。

  • failed:连接失败。

create_time

String

参数解释

创建时间,格式为yyyy-MM-dd HH:mm:ss。例如:'2025-04-21 17:05:53'。

取值范围

不涉及。

update_time

String

参数解释

更新时间,格式为yyyy-MM-dd HH:mm:ss。例如:'2025-04-21 17:05:53'。

取值范围

不涉及。

lastest_connection_time

String

参数解释

最后一次主机连通性验证时间,格式为yyyy-MM-dd HH:mm:ss。例如:'2025-04-21 17:05:53'。

取值范围

不涉及。

connection_result

String

参数解释

连通性验证结果。

取值范围

不涉及。

install_icagent

Boolean

参数解释

icagent安装状态。

取值范围

  • true:已安装。

  • false:未安装。

nick_name

String

参数解释

创建者用户昵称。

取值范围

字符串,长度为[1-30]个字符。

表5 HostAuthorizationBody

参数

参数类型

描述

username

String

参数解释

登录主机用户名。

取值范围

只能由字母、数字、下划线、中划线、点号、 @ 符号组成,长度[2-32]字符。

password

String

参数解释

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

取值范围

不能包含空格、换行符、回车符、制表符、双引号和单引号,且长度[5-32]个字符。

private_key

String

参数解释

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

取值范围

最大长度不超过5000个字符。

trusted_type

Integer

参数解释

登录主机时认证类型。

取值范围

  • 0:密码认证。

  • 1:密钥认证。

表6 PermissionHostDetailNew

参数

参数类型

描述

can_view

Boolean

参数解释

是否有查看权限。

取值范围

  • true: 有权限

  • false: 无权限

can_edit

Boolean

参数解释

是否有编辑权限。

取值范围

  • true: 有权限

  • false: 无权限

can_delete

Boolean

参数解释

是否有删除的权限。

取值范围

  • true: 有权限

  • false: 无权限

can_add_host

Boolean

参数解释

是否有添加主机权限。

取值范围

  • true:有添加主机权限。

  • false:无添加主机权限。

can_copy

Boolean

参数解释

是否有复制主机的权限。

取值范围

  • true:有复制主机的权限。

  • false:无复制主机的权限。

请求示例

https://{endpoint}/v1/resources/host-groups/ab7647b0863c4e969c8949d38d591339/hosts/300d6d2e53624d0da08b182099ad10f7

响应示例

状态码:200

OK 请求响应成功

{
  "result" : {
    "host_id" : "300d6d2e53624d0da08b182099ad10f7",
    "ip" : "100.101.28.215",
    "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_copy" : true
    },
    "group_id" : "ab7647b0863c4e969c8949d38d591339",
    "host_name" : "100.101.28.215",
    "as_proxy" : false,
    "proxy_host_id" : null,
    "owner_name" : "devcloud_devcloud_l00490255_01",
    "proxy_host" : null,
    "connection_status" : "success",
    "install_icagent" : false,
    "create_time" : "2021-05-13 09:35:41",
    "update_time" : "2021-05-13 09:35:41",
    "connection_result" : "连接成功",
    "lastest_connection_time" : "2021-05-13 09:36:11",
    "nick_name" : "AB边账号"
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码