查询指定堡垒机用户已授权或未授权的主机列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
yundun-bastionhost:ListHostsForUser |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
指定要查询的用户所在堡垒机实例的 ID。 说明
您可以调用 DescribeInstances 接口获取该参数。 |
bastionhost-cn-st220aw**** |
| RegionId |
string |
否 |
指定要的用户所在堡垒机的区域 ID。 说明
区域 ID 和区域名称的对应关系,请参见地域和可用区。 |
cn-hangzhou |
| Mode |
string |
否 |
指定要查询的主机列表的模式。取值:
|
Authorized |
| UserId |
string |
是 |
指定要查询的用户 ID。 说明
您可以调用 ListUsers 接口获取该参数。 |
1 |
| PageNumber |
string |
否 |
指定分页查询时,当前页的页码。默认值为 1。 |
1 |
| PageSize |
string |
否 |
指定分页查询时,每页显示的数据最大条数。 说明
建议 PageSize 取值不要为空。 |
20 |
| HostAddress |
string |
否 |
指定要查询的主机地址,可使用域名或 IP 地址。仅支持精确查询。 |
192.168.XX.XX |
| HostName |
string |
否 |
指定要查询的主机名称。仅支持精确查询。 |
abc |
| OSType |
string |
否 |
指定要查询的主机的操作系统类型。取值:
|
Linux |
调用 API 时,除了本文中该 API 的请求参数,还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍,请参见公共参数。 调用 API 的请求格式,请参见本文示例中的请求示例。
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| TotalCount |
integer |
查询到的主机总数量。 |
1 |
| RequestId |
string |
阿里云为该请求生成的唯一标识符。 |
EC9BF0F4-8983-491A-BC8C-1B4DD94976DE |
| Hosts |
array<object> |
查询到的主机列表。 |
|
|
object |
|||
| Comment |
string |
主机的备注信息。 |
comment |
| ActiveAddressType |
string |
主机的地址类型。取值:
|
Public |
| HostPublicAddress |
string |
主机的公网地址,可为域名或 IP 地址。 |
10.158.XX.XX |
| HostName |
string |
主机名称。 |
host01 |
| HostPrivateAddress |
string |
主机的私网地址,可为域名或 IP 地址。 |
192.168.XX.XX |
| OSType |
string |
主机的操作系统类型。取值:
|
Linux |
| HostId |
string |
主机 ID。 |
1 |
示例
正常返回示例
JSON格式
{
"TotalCount": 1,
"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE ",
"Hosts": [
{
"Comment": "comment",
"ActiveAddressType": "Public",
"HostPublicAddress": "10.158.XX.XX",
"HostName": "host01",
"HostPrivateAddress": "192.168.XX.XX",
"OSType": "Linux",
"HostId": "1"
}
]
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | The argument is invalid. | 参数错误 |
| 500 | InternalError | An unknown error occurred. | 未知错误 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。