调用ListHostsForUser接口查询指定堡垒机用户已授权或未授权的主机列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListHostsForUser |
需要执行的操作。 取值:ListHostsForUser。 |
InstanceId | String | 是 | bastionhost-cn-st220aw**** |
指定要查询的用户所在堡垒机实例的ID。 说明 您可以调用DescribeInstances接口获取该参数。
|
UserId | String | 是 | 1 |
指定要查询的用户ID。 说明 您可以调用ListUsers接口获取该参数。
|
RegionId | String | 否 | cn-hangzhou |
指定要的用户所在堡垒机的区域ID。 说明 区域ID和区域名称的对应关系,请参见地域和可用区。
|
Mode | String | 否 | Authorized |
指定要查询的主机列表的模式。取值:
|
PageNumber | String | 否 | 1 |
指定分页查询时,当前页的页码。默认值为1。 |
PageSize | String | 否 | 20 |
指定分页查询时,每页显示的数据最大条数。 PageSize参数最大取值为100。每页默认显示的数据条数为20条,PageSize参数值为空时,将默认返回20条数据。 说明 建议PageSize取值不要为空。
|
HostAddress | String | 否 | 192.168.XX.XX |
指定要查询的主机地址,可使用域名或IP地址。仅支持精确查询。 |
HostName | String | 否 | abc |
指定要查询的主机名称。仅支持精确查询。 |
OSType | String | 否 | Linux |
指定要查询的主机的操作系统类型。取值:
|
调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数。
调用API的请求格式,请参见本文示例中的请求示例。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Hosts | Array of Item |
查询到的主机列表。 |
|
ActiveAddressType | String | Public |
主机的地址类型。取值:
|
Comment | String | comment |
主机的备注信息。 |
HostId | String | 1 |
主机ID。 |
HostName | String | host01 |
主机名称。 |
HostPrivateAddress | String | 192.168.XX.XX |
主机的私网地址,可为域名或IP地址。 |
HostPublicAddress | String | 10.158.XX.XX |
主机的公网地址,可为域名或IP地址。 |
OSType | String | Linux |
主机的操作系统类型。取值:
|
RequestId | String | EC9BF0F4-8983-491A-BC8C-1B4DD94976DE |
阿里云为该请求生成的唯一标识符。 |
TotalCount | Integer | 1 |
查询到的主机总数量。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListHostsForUser
&InstanceId=bastionhost-cn-st220aw****
&UserId=1
&<公共请求参数>
正常返回示例
XML
格式
<ListHostsForUserResponse>
<Hosts>
<Comment>comment</Comment>
<ActiveAddressType>Public</ActiveAddressType>
<HostPrivateAddress>192.168.XX.XX</HostPrivateAddress>
<HostPublicAddress>10.158.XX.XX</HostPublicAddress>
<OSType>Linux</OSType>
<HostId>1</HostId>
<HostName>host01</HostName>
</Hosts>
<TotalCount>1</TotalCount>
<RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE </RequestId>
</ListHostsForUserResponse>
JSON
格式
{
"Hosts": [{
"Comment": "comment",
"ActiveAddressType": "Public",
"HostPrivateAddress": "192.168.XX.XX",
"HostPublicAddress": "10.158.XX.XX",
"OSType": "Linux",
"HostId": "1",
"HostName": "host01"
}],
"TotalCount": "1",
"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE "
}
错误码
访问错误中心查看更多错误码。