查询指定堡垒机实例下的主机列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| yundun-bastionhost:ListHosts | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | 要查询主机的堡垒机实例 ID。 说明
您可以调用 DescribeInstances 接口获取该参数。
| bastionhost-cn-st220aw**** |
| RegionId | string | 否 | 要查询主机的堡垒机所在地域的 ID。 说明
地域 ID 和地域名称的对应关系，请参见地域和可用区。
| cn-hangzhou |
| PageNumber | string | 否 | 设置从返回结果的第几页开始显示查询结果。默认值为 1，表示从第 1 页开始显示。 | 1 |
| PageSize | string | 否 | 设置分页查询时，每页显示的主机信息的数量。默认值为 10，表示每页显示 10 条主机信息。 说明
建议 PageSize 取值不要为空。
| 20 |
| OSType | string | 否 | 要查询的主机的操作系统。取值：
| Linux |
| HostName | string | 否 | 要查询的主机名称。不支持模糊查询，只支持精确查询。 | host |
| HostAddress | string | 否 | 要查询的主机地址，可使用域名或 IP 地址。不支持模糊查询，只支持精确查询。 | 1.1.XX.XX |
| Source | string | 否 | 要查询主机的来源。取值：
| Local |
| SourceInstanceId | string | 否 | 要查询的主机对应的 ECS 实例 ID 或专属集群主机 ID。不支持模糊查询，只支持精确查询。 | i-bp19ienyt0yax748**** |
| SourceInstanceState | string | 否 | 要查询的主机状态。取值：
| Normal |
| HostGroupId | string | 否 | 要查询的主机所在主机组的 ID。 说明
您可以调用 ListHostGroups 接口获取主机组 ID。
| 1 |
返回参数
示例
正常返回示例
JSON格式
{
"TotalCount": 1,
"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
"Hosts": [
{
"Comment": "host",
"ActiveAddressType": "Public",
"HostPublicAddress": "1.1.XX.XX",
"HostName": "name",
"HostAccountCount": 1,
"Source": "Local",
"HostPrivateAddress": "192.168.XX.XX",
"OSType": "Linux",
"HostId": "1",
"SourceInstanceState": "Normal",
"SourceInstanceId": "i-bp19ienyt0yax748****"
}
]
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParameter | The argument is invalid. | 参数错误 |
| 500 | InternalError | An unknown error occurred. | 未知错误 |
访问错误中心查看更多错误码。