GetHostAccount - Bastionhost - Alibaba Cloud Documentation Center

Queries the details of a specified host account.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

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 Key: the condition key that is defined by the cloud service.
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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-bastionhost:GetHostAccount	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the bastion host in which you want to query the details of the host account. Note You can call the DescribeInstances operation to query the ID of the bastion host.	bastionhost-cn-st220aw****
RegionId	string	No	The region ID of the bastion host in which you want to query the details of the host account. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
HostAccountId	string	Yes	The ID of the host account that you want to query. Note You can call the ListHostAccounts operation to query the ID of the host account.	1

Response parameters

Parameter	Type	Description	Example
	object	The data returned.
RequestId	string	The ID of the request.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
HostAccount	object	The details of the host account that was queried.
HasPassword	boolean	Indicates whether a password is configured for the host account. Valid values: true: yes false: no	true
PrivateKeyFingerprint	string	The fingerprint of the private key.	fe:ca:37:42:30:00:9d:95:e6:73:e5:b0:32:0a::
ProtocolName	string	The protocol that is used by the host. Valid values: SSH RDP	SSH
HostAccountName	string	The name of the host account.	abc
HostAccountId	string	The ID of the host account.	1
HostId	string	The ID of the host to which the host account belongs.	1
HostShareKeyId	string	The ID of the shared key.	1
HostShareKeyName	string	The name of the shared key.	name

Examples

Sample success responses

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 status code	Error code	Error message	Description
400	InvalidParameter	The argument is invalid.	The argument is invalid.
404	HostAccountNotFound	The host account is not found.	The host account is not found.
500	InternalError	An unknown error occurred.	An unknown error occurred.

For a list of error codes, visit the Service error codes.