GetHostAccount - 获取指定主机账户详情

获取指定主机账户详情。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-bastionhost:GetHostAccount

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

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

说明

您可以调用 DescribeInstances 接口获取该参数。

bastionhost-cn-st220aw****

RegionId

string

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

说明

区域 ID 和区域名称的对应关系,请参见地域和可用区

cn-hangzhou

HostAccountId

string

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

说明

您可以调用 ListHostAccounts 接口获取该参数。

1

返回参数

名称

类型

描述

示例值

object

响应数据。

RequestId

string

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

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

HostAccount

object

查询到的主机账户详细信息。

HasPassword

boolean

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

  • true:已设置密码。

  • false:未设置密码。

true

PrivateKeyFingerprint

string

私钥的指纹信息。

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

ProtocolName

string

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

  • SSH

  • RDP

SSH

HostAccountName

string

主机账户名称。

abc

HostAccountId

string

主机账户 ID。

1

HostId

string

主机账户所属主机的 ID。

1

HostShareKeyId

string

主机共享密钥 ID。

1

RotationMode

string

账户改密模式。

  • Privileged:使用特权账户改密

  • Self:不使用特权账户改密

说明

仅支持 V3.2.47 及以上的版本使用。

Privileged

HostShareKeyName

string

主机共享密钥名称。

name

PrivilegeType

string

账户权限类型。

  • Privileged:特权账户

  • Normal:普通账户

说明

仅支持 V3.2.47 及以上的版本使用。

Normal

示例

正常返回示例

JSON格式

{
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "HostAccount": {
    "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",
    "RotationMode": "Privileged",
    "HostShareKeyName": "name",
    "PrivilegeType": "Normal"
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter The argument is invalid. 参数错误
500 InternalError An unknown error occurred. 未知错误
404 HostAccountNotFound The host account is not found. 主机账号不存在

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

变更历史

更多信息,参考变更详情