ListHostAccountsForHostShareKey - Bastionhost - Alibaba Cloud Documentation Center

Queries the host accounts that are associated with a shared key.

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:ListHostAccountsForHostShareKey	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The bastion host ID. Note You can call the DescribeInstances operation to query the bastion host ID.	bastionhost-cn-st220aw****
RegionId	string	No	The region ID of the bastion host. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
HostShareKeyId	string	Yes	The shared key ID. Note You can call the ListHostShareKeys operation to query the shared key ID.	1124
PageNumber	string	No	The number of the page to return. Default value: 1.	1
PageSize	string	No	The number of entries to return on each page. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
HostAccounts	array<object>	An array that consists of the host accounts that are associated with the shared key.
Item	object
HostAccountName	string	The name of the host account.	root1234
HostId	string	The ID of the host.	1113
HostsAccountId	string	The ID of the host account.	1235
ProtocolName	string	The O&M protocol.	SSH
TotalCount	long	The total number of the host accounts that are associated with the shared key.	5

Examples

Sample success responses

JSONformat

{
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "HostAccounts": [
    {
      "HostAccountName": "root1234",
      "HostId": "1113",
      "HostsAccountId": "1235",
      "ProtocolName": "SSH"
    }
  ],
  "TotalCount": 5
}

Error codes

HTTP status code	Error code	Error message	Description
400	HostShareKeyNotFound	The host share key is not found.	-
400	InvalidParameter	The argument is invalid.	The argument is invalid.
500	InternalError	An unknown error occurred.	An unknown error occurred.

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