文档

GetHost - 获取指定主机的详细信息

更新时间:

包括主机名称、来源、主机地址、协议端口等信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-bastionhost:GetHostRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdstring

指定要查询的主机所在堡垒机的实例 ID。

说明 您可以调用 DescribeInstances 接口获取该参数。
bastionhost-cn-st220aw****
RegionIdstring

指定要查询的主机所在堡垒机的区域 ID。

说明 Region ID 和区域名称的对应关系,请参见地域和可用区
cn-hangzhou
HostIdstring

指定要查询的主机 ID。仅支持输入一个主机 ID。

说明 您可以调用 ListHosts 接口获取该参数。
1

返回参数

名称类型描述示例值
object
RequestIdstring

阿里云为该请求生成的唯一标识符。

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Hostobject

查询到的主机信息。

Commentstring

主机的备注信息。

host
ActiveAddressTypestring

主机地址类型。取值:

  • Public :公网地址
  • Private :私网地址
Public
HostPublicAddressstring

主机的公网地址,可为域名或 IP 地址。

1.1.XX.XX
HostNamestring

主机名称。

host
Sourcestring

主机的来源。取值:

  • Local:本地主机
  • Ecs:ECS 实例
  • Rds:RDS 专属集群主机
Local
HostPrivateAddressstring

主机的私网地址,可为域名或 IP 地址。

192.168.XX.XX
OSTypestring

主机的操作系统。取值:

  • Linux
  • Windows
Linux
HostIdstring

主机 ID。

1
SourceInstanceStatestring

主机状态。取值:

  • Normal :正常
  • Release: 已释放
Normal
SourceInstanceIdstring

主机对应的 ECS 实例 ID 或专属集群主机 ID。

说明 SourceLocal 时,该参数返回值为空。
i-bp19ienyt0yax748****
Protocolsobject []

主机的协议信息。

HostFingerPrintstring

主机指纹信息,可以唯一标识一台主机。

ssh-ed25519|3e:46:5a:e1:1f:0d:39:7e:61:35:d5:fa:7b:2b:**:**
Portinteger

主机的服务端口。

22
ProtocolNamestring

主机使用的协议名称。取值:

  • SSH
  • RDP
SSH
NetworkDomainIdstring

主机所属的网络域的 ID。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "Host": {
    "Comment": "host",
    "ActiveAddressType": "Public",
    "HostPublicAddress": "1.1.XX.XX",
    "HostName": "host",
    "Source": "Local",
    "HostPrivateAddress": "192.168.XX.XX",
    "OSType": "Linux",
    "HostId": "1",
    "SourceInstanceState": "Normal",
    "SourceInstanceId": "i-bp19ienyt0yax748****",
    "Protocols": [
      {
        "HostFingerPrint": "ssh-ed25519|3e:46:5a:e1:1f:0d:39:7e:61:35:d5:fa:7b:2b:**:**",
        "Port": 22,
        "ProtocolName": "SSH"
      }
    ],
    "NetworkDomainId": "1"
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe argument is invalid.参数错误
400HostNotFoundThe host is not found.主机不存在
500InternalErrorAn unknown error occurred.未知错误

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-11-27OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈