调用ListHostAccountsForUserGroup查询已授权的主机账户列表_运维安全中心（堡垒机）(Bastionhost)-阿里云帮助中心

查询指定用户组在指定主机下已授权和未授权的主机账户列表。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值

名称	类型	必填	描述	示例值
InstanceId	string	是	指定要查询已授权主机账户列表的用户组所在堡垒机的实例 ID。说明您可以调用 DescribeInstances 接口获取该参数。	bastionhost-cn-st220aw****
RegionId	string	否	指定要查询已授权主机账户列表的用户组所在堡垒机的区域 ID。说明区域 ID 和区域名称的对应关系，请参见地域和可用区。	cn-hangzhou
UserGroupId	string	是	指定要查询已授权主机账户列表的用户组 ID。说明您可以调用 ListUserGroups 接口获取该参数。	1
HostId	string	是	指定要查询的主机账户的主机 ID。说明您可以调用 ListHosts 接口获取该参数。	1
PageNumber	string	否	指定分页查询时，当前页的页码。默认值为 1。	1
PageSize	string	否	指定分页查询时，每页显示的数据最大条数。 PageSize 参数最大取值为 100。每页默认显示的数据条数为 20 条，PageSize 参数值为空时，将默认返回 20 条数据。说明建议 PageSize 取值不要为空。	20
HostAccountName	string	否	指定要查询的主机账户名称。支持精确查询。	root

调用 API 时，除了本文中该 API 的请求参数，还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍，请参见公共参数。调用 API 的请求格式，请参见本文示例中的请求示例。

返回参数

名称	类型	描述	示例值

名称	类型	描述	示例值
	object
TotalCount	integer	查询到的主机账户总数量。	1
RequestId	string	阿里云为该请求生成的唯一标识符。	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
HostAccounts	array<object>	查询到的主机账户列表。
Item	object
HostAccountName	string	主机账户名称。	host１
HostAccountId	string	主机账户 ID。	1
IsAuthorized	boolean	主机账户是否授权给当前用户组。取值： true：已授权 false：未授权	true
ProtocolName	string	主机账户的协议名称。取值： SSH RDP	SSH
HostId	string	主机账户所在主机的 ID。	１

示例

正常返回示例

JSON格式

        

          
      
        
{
  "TotalCount": 1,
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "HostAccounts": [
    {
      "HostAccountName": "host１",
      "HostAccountId": "1",
      "IsAuthorized": true,
      "ProtocolName": "SSH",
      "HostId": "１"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	The argument is invalid.	参数错误
500	InternalError	An unknown error occurred.	未知错误

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