调用ListHostAccounts接口获取主机账户列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListHostAccounts

需要执行的操作。

取值:ListHostAccounts

HostId String 1

指定要查询主机账户的主机ID。

说明 您可以调用ListHosts接口获取该参数。
InstanceId String bastionhost-cn-st220aw****

指定要查询的主机所在堡垒机的实例ID。

说明 您可以调用DescribeInstances接口获取该参数。
RegionId String cn-hangzhou

指定要查询的主机所在堡垒机的区域ID。

说明 区域ID和区域名称的对应关系,请参见地域和可用区
PageNumber String 1

指定分页查询时,当前页的页码。默认值为1

PageSize String 20

指定分页查询时,每页显示的数据最大条数。

PageSize参数最大取值为100。每页默认显示的数据条数为20条,PageSize参数值为空时,将默认返回20条数据。

说明 建议PageSize取值不要为空。
HostAccountName String abc

指定要查询的主机账户名称。最多支持128字符,仅支持精确查询。

ProtocolName String SSH

指定要查询的主机账户的协议名称。取值:

  • SSH
  • RDP

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

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
HostAccounts Array of Item

查询到的主机账户列表。

HasPassword Boolean true

当前主机账户是否设置了密码。取值:

  • true:已设置密码。
  • false:未设置密码。
HostAccountId String 1

主机账户ID。

HostAccountName String abc

主机账户名称。

HostId String 1

主机ID。

PrivateKeyFingerprint String fe:ca:37:42:30:00:9d:95:e6:73:e5:b0:32:0a:**:**

主机账户的私钥指纹信息。

ProtocolName String SSH

主机账户的协议名称。取值:

  • SSH
  • RDP
RequestId String EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

阿里云为该请求生成的唯一标识符。

TotalCount Integer 1

查询到的主机账户总数量。

示例

请求示例

http(s)://[Endpoint]/?Action=ListHostAccounts
&HostId=1
&InstanceId=bastionhost-cn-st220aw****
&<公共请求参数>

正常返回示例

XML格式

<ListHostAccountsResponse>
      <TotalCount>1</TotalCount>
      <RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
      <HostAccounts>
            <HostAccountName>abc</HostAccountName>
            <ProtocolName>SSH</ProtocolName>
            <PrivateKeyFingerprint>fe:ca:37:42:30:00:9d:95:e6:73:e5:b0:32:0a:**:**</PrivateKeyFingerprint>
            <HostId>1</HostId>
            <HasPassword>true</HasPassword>
            <HostAccountId>1</HostAccountId>
      </HostAccounts>
</ListHostAccountsResponse>

JSON格式

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

错误码

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