调用ListHostAccounts获取主机账户列表_运维安全中心（堡垒机）(Bastionhost)-阿里云帮助中心

获取主机账户列表。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-bastionhost:ListHostAccounts

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	指定要查询的主机所在堡垒机的实例 ID。说明您可以调用 DescribeInstances 接口获取该参数。	bastionhost-cn-st220aw****
RegionId	string	否	指定要查询的主机所在堡垒机的地域 ID。说明地域 ID 和地域名称的对应关系，请参见地域和可用区。	cn-hangzhou
HostId	string	是	指定要查询主机账户的主机 ID。说明您可以调用 ListHosts 接口获取该参数。	1
PageNumber	string	否	指定分页查询时，当前页的页码。默认值为 1。	1
PageSize	string	否	指定分页查询时，每页显示的数据最大条数。 PageSize 参数最大取值为 100。每页默认显示的数据条数为 20 条，PageSize 参数值为空时，将默认返回 20 条数据。说明建议 PageSize 取值不要为空。	20
HostAccountName	string	否	指定要查询的主机账户名称。最多支持 128 字符，仅支持精确查询。	abc
ProtocolName	string	否	指定要查询的主机账户的协议名称。取值： SSH RDP	SSH
HostIds	string	否	指定要查询主机账户的主机 ID 数组。说明当 HostId 参数有值且不为 0 时，将忽略本参数。仅当 HostId 参数取值为 0 时，本参数有效。	["2","3"]

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	查询到的主机账户总数量。	1
RequestId	string	阿里云为该请求生成的唯一标识符。	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
HostAccounts	array<object>	查询到的主机账户列表。
	object
ProtocolName	string	主机账户的协议名称。取值： SSH RDP	SSH
PrivateKeyFingerprint	string	主机账户的私钥指纹信息。	fe:ca:37:42:30:00:9d:95:e6:73:e5:b0:32:0a::
HostId	string	主机 ID。	1
HostAccountId	string	主机账户 ID。	1
HostAccountName	string	主机账户名称。	abc
RotationMode	string	账户改密模式。 Privileged：使用特权账户改密 Self：不使用特权账户改密说明仅支持 V3.2.47 及以上的版本使用。	Privileged
HostShareKeyName	string	主机共享密钥名称。	name
HasPassword	boolean	当前主机账户是否设置了密码。取值： true：已设置密码。 false：未设置密码。	true
HostShareKeyId	string	主机共享密钥 ID。	1
PrivilegeType	string	账户权限类型。 Privileged：特权账户 Normal：普通账户说明仅支持 V3.2.47 及以上的版本使用。	Normal

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "HostAccounts": [
    {
      "ProtocolName": "SSH",
      "PrivateKeyFingerprint": "fe:ca:37:42:30:00:9d:95:e6:73:e5:b0:32:0a:**:**",
      "HostId": "1",
      "HostAccountId": "1",
      "HostAccountName": "abc",
      "RotationMode": "Privileged",
      "HostShareKeyName": "name",
      "HasPassword": true,
      "HostShareKeyId": "1",
      "PrivilegeType": "Normal"
    }
  ]
}

错误码

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

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

变更历史

更多信息，参考变更详情。