All Products
Search
Document Center

Bastionhost:GetHostAccount

Last Updated:Jan 31, 2023

Queries the details of a specified host account.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operateaccess levelResource typeconditional keywordAssociation operation
yundun-bastionhost:GetHostAccountRead
    All resources
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the Bastionhost instance where you want to query the details of the host account.

NoteYou can call the DescribeInstances operation to query the ID of the Bastionhost instance.
bastionhost-cn-st220aw****
RegionIdstringNo

The region ID of the Bastionhost instance where you want to query the details of the host account.

NoteFor more information about the mapping between region IDs and region names, see Regions and zones.
cn-hangzhou
HostAccountIdstringYes

The ID of the host account that you want to query.

NoteYou can call the ListHostAccounts operation to query the ID of the host account.
1

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

The details of the host account that were queried.

HasPasswordboolean

Indicates whether a password is set for the host account. Valid values:

  • true: indicates that a password is set for the host account.
  • false: indicates that no password is set for the host account.
true
PrivateKeyFingerprintstring

The fingerprint of the private key.

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

The protocol used by the host account. Valid values:

  • SSH
  • RDP
SSH
HostAccountNamestring

The name of the host account.

abc
HostAccountIdstring

The ID of the host account.

1
HostIdstring

The ID of the host to which the host account belongs.

1
HostShareKeyIdstring

The ID of the shared key.

1
HostShareKeyNamestring

The name of the shared key.

name

Example

Normal return example

JSONFormat

{
  "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",
    "HostShareKeyName": "name"
  }
}

Error codes

Http codeError codeError messageDescription
400InvalidParameterThe argument is invalid.The argument is invalid.
404HostAccountNotFoundThe host account is not found.The host account is not found.
500InternalErrorAn unknown error occurred.An unknown error occurred.

For a list of error codes, visit the API error center.