DescribeInstances - Bastionhost - Alibaba Cloud Documentation Center

Queries a list of Bastionhost instances.

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

get

*Instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of Bastionhost instances to return on each page. Default value: 10.	10
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
RegionId	string	No	The ID of the region where the Bastionhost instance resides.	cn-hangzhou
InstanceStatus	string	No	The status of the Bastionhost instance. Valid values: PENDING: The instance is not initialized. CREATING: The instance is being created. RUNNING: The instance is running. EXPIRED: The instance is expired. CREATE_FAILED: The instance failed to be created. UPGRADING: The instance is being upgraded or downgraded. UPGRADE_FAILED: The instance failed to be upgraded or downgraded.	RUNNING
ResourceGroupId	string	No	The ID of the resource group to which the Bastionhost instance belongs.	rg-acfm26ougi****
InstanceId	array	No	The ID of the Bastionhost instance.	bastionhost-cn-78v1ghxxxxx
	string	No	The ID of the Bastionhost instance.	2
Tag	array<object>	No	The tags of the Bastionhost instance.
	object	No	The tags of the Bastionhost instance.
Key	string	No	The tag key of the instance.	test
Value	string	No	The tag value of the instance.	testapi

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of Bastionhost instances that are returned.	4
RequestId	string	The ID of the request. This is a unique identifier generated by Alibaba Cloud for the request. You can use it to troubleshoot and locate issues.	61D36C55-AAFC-4678-8FAD-34FEF9E7182E
Instances	array<object>	A list of the Bastionhost instances.
	object
VpcId	string	The ID of the VPC to which the Bastionhost instance is attached.	vpc-bp1c85tzgqu1bf5b****
VswitchId	string	The ID of the vSwitch to which the Bastionhost instance is attached.	vsw-bp1xfwzzfti0kjbf****
ImageVersion	string	The image version of the Bastionhost instance.	3.2.41
PlanCode	string	The edition of the Bastionhost instance. Valid values: cloudbastion: Basic Edition cloudbastion_ha: Enterprise Edition	cloudbastion_ha
Description	string	The description of the Bastionhost instance.	测试API
ExpireTime	integer	The expiration time of the Bastionhost instance. This value is a UNIX timestamp. Unit: milliseconds.	1578326400000
Legacy	boolean	Indicates whether the Bastionhost instance is a legacy instance. Valid values: true: The instance is a V2 or V3.1 series instance. false: The instance is a V3.2 series instance.	false
InstanceId	string	The ID of the Bastionhost instance.	bastionhost-cn-78v1gh****
InternetEndpoint	string	The public domain name of the Bastionhost instance.	******lwb-public.bastionhost.aliyuncs.com
RegionId	string	The ID of the region where the Bastionhost instance resides.	cn-hangzhou
IntranetEndpoint	string	The private domain name of the Bastionhost instance.	******lwb.bastionhost.aliyuncs.com
StartTime	integer	The time when the Bastionhost instance was purchased or renewed. This value is a UNIX timestamp. Unit: milliseconds.	1577681345000
ResourceGroupId	string	The ID of the resource group to which the Bastionhost instance belongs.	g-acfm26ougi****
InstanceStatus	string	The status of the Bastionhost instance. Valid values: PENDING: The instance is not initialized. CREATING: The instance is being created. RUNNING: The instance is running. EXPIRED: The instance is expired. CREATE_FAILED: The instance failed to be created. UPGRADING: The instance is being upgraded or downgraded. UPGRADE_FAILED: The instance failed to be upgraded or downgraded.	RUNNING
LicenseCode	string	The license code of the Bastionhost instance.	bhah_ent_50_asset
PublicNetworkAccess	boolean	Indicates whether the Bastionhost instance is accessible over the Internet. Valid values: true: The instance is accessible over the Internet. false: The instance is not accessible over the Internet.	true
SlaveVswitchId	string
BandWidth	integer

Examples

Success response

JSON format

{
  "TotalCount": 4,
  "RequestId": "61D36C55-AAFC-4678-8FAD-34FEF9E7182E",
  "Instances": [
    {
      "VpcId": "vpc-bp1c85tzgqu1bf5b****",
      "VswitchId": "vsw-bp1xfwzzfti0kjbf****",
      "ImageVersion": "3.2.41",
      "PlanCode": "cloudbastion_ha",
      "Description": "测试API",
      "ExpireTime": 1578326400000,
      "Legacy": false,
      "InstanceId": "bastionhost-cn-78v1gh****",
      "InternetEndpoint": "******lwb-public.bastionhost.aliyuncs.com",
      "RegionId": "cn-hangzhou",
      "IntranetEndpoint": "******lwb.bastionhost.aliyuncs.com",
      "StartTime": 1577681345000,
      "ResourceGroupId": "g-acfm26ougi****",
      "InstanceStatus": "RUNNING",
      "LicenseCode": "bhah_ent_50_asset",
      "PublicNetworkAccess": true,
      "SlaveVswitchId": "",
      "BandWidth": 0
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.