Call ListHosts to query hosts - Bastionhost - Alibaba Cloud - Bastionhost

Queries the hosts of a specified Bastionhost instance.

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

get

*Instance

acs:yundun-bastionhost:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID of the Bastionhost instance. Note You can invoke the DescribeInstances operation to obtain this parameter.	bastionhost-cn-st220aw****
RegionId	string	No	The region ID of the Bastionhost instance. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
PageNumber	string	No	The number of the page to return. Default value: 1.	1
PageSize	string	No	Settings for paging. Specifies the number of host information entries to return per page in a paged query. Default value: 10, which indicates that 10 host information entries are displayed per page. Note Do not leave PageSize empty.	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 match is supported.	host
HostAddress	string	No	The address of the host. A domain name or an IP address is supported. Only exact match is supported.	1.1.XX.XX
Source	string	No	The source of the host. Valid values: Local: local host Ecs: ECS instance Rds: ApsaraDB RDS dedicated cluster host	Local
SourceInstanceId	string	No	The ECS instance ID or the dedicated cluster host ID that corresponds to the host. Only exact match is supported.	i-bp19ienyt0yax748****
SourceInstanceState	string	No	The status of the host. Valid values: Normal: normal Release: released	Normal
HostGroupId	string	No	The ID of the host group to which the host belongs. Note You can call the ListHostGroups operation to query the host group ID.	1
ProjectId	string	No	The project ID.	3

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of hosts queried.	1
RequestId	string	The request ID.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Hosts	array<object>	The list of hosts queried.
	object
Comment	string	The description of the host.	host
ActiveAddressType	string	The address type of the host. Valid values: Public: public address Private: private endpoint in the private network	Public
HostPublicAddress	string	The public address of the host, which can be a domain name or an IP address.	1.1.XX.XX
HostName	string	The name of the host.	name
HostAccountCount	integer	The number of host accounts.	1
Source	string	The source of the host. Valid values: Local: local host Ecs: ECS instance Rds: ApsaraDB RDS dedicated cluster host	Local
HostPrivateAddress	string	The private endpoint in the private network of the host, which can be a domain name or an IP address.	192.168.XX.XX
OSType	string	The operating system of the host. Valid values: Linux Windows	Linux
HostId	string	The host ID.	1
SourceInstanceState	string	The status of the host. Valid values: Normal: normal Release: released	Normal
SourceInstanceId	string	The ECS instance ID or the dedicated cluster host ID that corresponds to the host. Note If Source is Local, this parameter is empty.	i-bp19ienyt0yax748****

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "Hosts": [
    {
      "Comment": "host",
      "ActiveAddressType": "Public",
      "HostPublicAddress": "1.1.XX.XX",
      "HostName": "name",
      "HostAccountCount": 1,
      "Source": "Local",
      "HostPrivateAddress": "192.168.XX.XX",
      "OSType": "Linux",
      "HostId": "1",
      "SourceInstanceState": "Normal",
      "SourceInstanceId": "i-bp19ienyt0yax748****"
    }
  ]
}

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.