获取已授权的主机列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 堡垒机的实例 ID。 说明
您可以调用 DescribeInstances 接口获取该参数。
| bastionhost-cn-09k22avmw0q |
RegionId | string | 否 | 堡垒机的区域 ID。 说明
区域 ID 和区域名称的对应关系,请参见地域和可用区。
| cn-hangzhou |
PageNumber | string | 否 | 指定分页查询时,当前页的页码。默认值为 1。 | 1 |
PageSize | string | 否 | 指定分页查询时,每页显示的数据最大条数。 说明
建议 PageSize 取值不要为空。
| 20 |
OSType | string | 否 | 指定要查询的主机的操作系统。取值:
| Linux |
HostName | string | 否 | 指定要查询的主机名称。不支持模糊查询,只支持精确查询。 | abc |
HostAddress | string | 否 | 指定要查询的主机地址,可使用域名或 IP 地址。不支持模糊查询,只支持精确查询。 | 10.162.172.132 |
Source | string | 否 | 指定要查询主机的来源。取值:
| Local |
SourceInstanceId | string | 否 | ECS 实例 ID。精确搜索。 | i-bp19ienyt0yax748**** |
SourceInstanceState | string | 否 | 指定要查询的主机状态。取值:
| Normal |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | The argument is invalid. | 参数错误 |
500 | InternalError | An unknown error occurred. | 未知错误 |
访问错误中心查看更多错误码。