全部产品
Search
文档中心

运维安全中心(堡垒机):ListHostAccounts - 获取主机账户列表

更新时间:Jan 31, 2023

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-bastionhost:ListHostAccountsList
    全部资源

请求参数

名称类型必填描述示例值
InstanceIdstring

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

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

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

说明地域ID和地域名称的对应关系,请参见地域和可用区
cn-hangzhou
HostIdstring

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

说明您可以调用ListHosts接口获取该参数。
1
PageNumberstring

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

1
PageSizestring

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

说明建议PageSize取值不要为空。
20
HostAccountNamestring

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

abc
ProtocolNamestring

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

  • SSH
  • RDP
SSH

返回参数

名称类型描述示例值
object
TotalCountinteger

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

1
RequestIdstring

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

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
HostAccountsarray

查询到的主机账户列表。

object
HasPasswordboolean

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

  • true:已设置密码。
  • false:未设置密码。
true
PrivateKeyFingerprintstring

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

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

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

  • SSH
  • RDP
SSH
HostAccountNamestring

主机账户名称。

abc
HostAccountIdstring

主机账户ID。

1
HostIdstring

主机ID。

1
HostShareKeyIdstring

主机共享密钥ID。

1
HostShareKeyNamestring

主机共享密钥名称。

name

示例

正常返回示例

JSON格式

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

错误码

Http code错误码错误信息描述
400InvalidParameterThe argument is invalid.参数错误
500InternalErrorAn unknown error occurred.未知错误

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