文档

ListOperationHosts - 获取已授权的主机列表

更新时间:

获取已授权的主机列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

堡垒机的实例 ID。

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

堡垒机的区域 ID。

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

指定分页查询时,当前页的页码。默认值为 1。

1
PageSizestring

指定分页查询时,每页显示的数据最大条数。
PageSize 参数最大取值为 100。每页默认显示的数据条数为 20 条,PageSize 参数值为空时,将默认返回 20 条数据。

说明 建议 PageSize 取值不要为空。
20
OSTypestring

指定要查询的主机的操作系统。取值:

  • Linux
  • Windows
Linux
HostNamestring

指定要查询的主机名称。不支持模糊查询,只支持精确查询。

abc
HostAddressstring

指定要查询的主机地址,可使用域名或 IP 地址。不支持模糊查询,只支持精确查询。

10.162.172.132
Sourcestring

指定要查询主机的来源。取值:

  • Local:本地主机
  • Ecs:ECS 实例
Local
SourceInstanceIdstring

ECS 实例 ID。精确搜索。

i-bp19ienyt0yax748****
SourceInstanceStatestring

指定要查询的主机状态。取值:

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

返回参数

名称类型描述示例值
object
Hostsobject []

查询到的主机列表。

ActiveAddressTypestring

主机地址类型。

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

主机的备注信息。

comment
HostIdstring

主机 ID。

1
HostNamestring

主机名称。

host1
HostPrivateAddressstring

主机的私网地址。

192.168.XX.XX
HostPublicAddressstring

主机的公网地址。

10.158.XX.XX
OSTypestring

主机的操作系统。

  • Linux
  • Windows
Linux
Sourcestring

主机的来源。

  • Local:本地主机
  • Ecs:ECS 实例
Local
SourceInstanceIdstring

ECS 实例 ID。

i-bp19ienyt0yax748****
SourceInstanceStatestring

主机状态。

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

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

4F6C075F-FC86-476E-943B-097BD4E12948
TotalCountlong

查询到的主机总数量。

5

示例

正常返回示例

JSON格式

{
  "Hosts": [
    {
      "ActiveAddressType": "Public",
      "Comment": "comment",
      "HostId": "1",
      "HostName": "host1",
      "HostPrivateAddress": "192.168.XX.XX",
      "HostPublicAddress": "10.158.XX.XX",
      "OSType": "Linux",
      "Source": "Local",
      "SourceInstanceId": "i-bp19ienyt0yax748****",
      "SourceInstanceState": "Normal"
    }
  ],
  "RequestId": "4F6C075F-FC86-476E-943B-097BD4E12948",
  "TotalCount": 5
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe argument is invalid.参数错误
500InternalErrorAn unknown error occurred.未知错误

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

  • 本页导读 (1)
文档反馈