ListOperationHosts - Bastionhost - Alibaba Cloud Documentation Center

Queries a list of hosts that the current Resource Access Management (RAM) user is authorized to access.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the bastion host instance. Note Call the DescribeInstances operation to obtain this parameter.	bastionhost-cn-09k22avmw0q
RegionId	string	No	The ID of the region where the bastion host resides. Note For more information about regions and zones, see Regions and zones.	cn-hangzhou
PageNumber	string	No	The number of the page to return. The default value is 1.	1
PageSize	string	No	The number of entries to return on each page. The maximum value is 100. The default value is 20. If you do not specify this parameter, the default value is used. Note Specify a value for this parameter.	20
OSType	string	No	The operating system of the host. Valid values: Linux Windows	Linux
HostName	string	No	The name of the host. Only exact matches are supported.	abc
HostAddress	string	No	The address of the host. You can specify a domain name or an IP address. Only exact matches are supported.	10.162.XX.XX
Source	string	No	The source of the host. Valid values: Local: a local host Ecs: an ECS instance	Local
SourceInstanceId	string	No	The ID of the ECS instance. Only exact matches are supported.	i-bp19ienyt0yax748****
SourceInstanceState	string	No	The state of the host. Valid values: Normal: The host is running. Release: The host is released.	Normal

Response elements

Element	Type	Description	Example
	object
Hosts	array<object>	A list of the hosts.
	object
ActiveAddressType	string	The address type of the host. Public: The public endpoint is used. Private: The private endpoint is used.	Public
Comment	string	The comments on the host.	comment
HostId	string	The ID of the host.	1
HostName	string	The name of the host.	host1
HostPrivateAddress	string	The private address of the host.	192.168.XX.XX
HostPublicAddress	string	The public address of the host.	10.158.XX.XX
OSType	string	The operating system of the host. Linux Windows	Linux
Source	string	The source of the host. Local: a local host Ecs: an ECS instance	Local
SourceInstanceId	string	The ID of the ECS instance.	i-bp19ienyt0yax748****
SourceInstanceState	string	The state of the host. Normal: The host is running. Release: The host is released.	Normal
RequestId	string	The ID of the request.	4F6C075F-FC86-476E-943B-097BD4E12948
TotalCount	integer	The total number of hosts.	5

Examples

Success response

JSON format

{
  "Hosts": [
    {
      "ActiveAddressType": "Public",
      "Comment": "comment",
      "HostId": "1",
      "HostName": "host1",
      "HostPrivateAddress": "192.168.XX.XX",
      "HostPublicAddress": "10.158.XX.XX",
      "OSType": "Linux",
      "Source": "Local",
      "SourceInstanceId": "i-bp19ienyt0yax748****",
      "SourceInstanceState": "Normal"
    }
  ],
  "RequestId": "4F6C075F-FC86-476E-943B-097BD4E12948",
  "TotalCount": 5
}

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.