ListOperationHostAccounts - Bastionhost - Alibaba Cloud Documentation Center

Queries a list of host accounts that the current Resource Access Management (RAM) user is authorized to manage.

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:ListOperationHostAccounts

*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
HostId	string	Yes	The ID of the host whose accounts you want to query. Note You can call the ListOperationHosts operation to query the host ID.	1
PageNumber	string	No	The page number. Default value: 1.	1
PageSize	string	No	The number of entries per page. Valid values: 1 to 100. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page. Note We recommend that you do not leave this parameter empty.	20
HostAccountName	string	No	The name of the host account to query. Only exact match is supported.	root

Response elements

Element	Type	Description	Example
	object
HostAccounts	array<object>	The host accounts returned.
	array<object>
HasPassword	boolean	Indicates whether a password is configured for the host account. true false	true
HostAccountId	string	The host account ID.	1
HostAccountName	string	The host account name.	root
HostId	string	The host ID.	１
HostShareKeyId	string	The ID of the shared key that is associated with the host.	3
PrivateKeyFingerprint	string	The fingerprint of the private key for the host account.	fe:ca:37:42:30:00:9d:95:e6:73:e5:b0:32:0a::
ProtocolName	string	The protocol that is used by the host account. SSH RDP	SSH
SSHConfig	object	Indicates whether the Secure File Transfer Protocol (SFTP) channels or the SSH channels are enabled for the host account that uses the SSH protocol.
EnableSFTPChannel	boolean	Indicates whether SFTP channels are enabled for the account.
EnableSSHChannel	boolean	Indicates whether SSH channels are enabled for the account.
RequestId	string	The request ID.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
TotalCount	integer	The total number of host accounts returned.	1

Examples

Success response

JSON format

{
  "HostAccounts": [
    {
      "HasPassword": true,
      "HostAccountId": "1",
      "HostAccountName": "root",
      "HostId": "１",
      "HostShareKeyId": "3",
      "PrivateKeyFingerprint": "fe:ca:37:42:30:00:9d:95:e6:73:e5:b0:32:0a:**:**",
      "ProtocolName": "SSH",
      "SSHConfig": {
        "EnableSFTPChannel": false,
        "EnableSSHChannel": false
      }
    }
  ],
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "TotalCount": 1
}

Error codes

HTTP status code	Error code	Error message	Description
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.