文档

ListOperationHostAccounts - 获取已授权的主机账户列表

更新时间:

获取已授权的主机账户列表。

调试

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

授权信息

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

请求参数

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

堡垒机的实例 ID。

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

堡垒机的区域 ID。

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

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

1
PageNumberstring

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

1
PageSizestring

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

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

指定要查询的主机账户名称。仅支持精确查询。

root

返回参数

名称类型描述示例值
object
HostAccountsobject []

查询到的主机账户列表。

HasPasswordboolean

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

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

主机账户 ID。

1
HostAccountNamestring

主机账户名称。

root
HostIdstring

主机 ID。

HostShareKeyIdstring

主机共享密钥 ID。

3
PrivateKeyFingerprintstring

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

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

主机账户的协议名称。

  • SSH
  • RDP
SSH
SSHConfigobject

SSH 账户运维权限。

EnableSFTPChannelboolean

该账户是否开启 SFTP 通道。

EnableSSHChannelboolean

该账户是否开启 SSH 通道。

RequestIdstring

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

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

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

1

示例

正常返回示例

JSON格式

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

错误码

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

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

  • 本页导读 (1)
文档反馈