ListHostAccountsForHostShareKey - Bastionhost - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-bastionhost:ListHostAccountsForHostShareKey

get

*All Resource

*

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 elements

Element	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.
	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	integer	The total number of the host accounts that are associated with the shared key.	5

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.