Query a list of Bastionhost instances by using DescribeInstances - Bastionhost

Lists 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries 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 region ID of the instance.	cn-hangzhou
InstanceStatus	string	No	The status of the bastion host. Valid values: PENDING: The bastion host is not initialized. CREATING: The bastion host is being created. RUNNING: The bastion host is running. EXPIRED: The bastion host expired. CREATE_FAILED: The bastion host fails to be created. UPGRADING: The bastion host is being upgraded. UPGRADE_FAILED: The bastion host fails to be upgraded.	RUNNING
ResourceGroupId	string	No	The ID of the resource group to which the bastion host belongs.	rg-acfm26ougi****
InstanceId	array	No	The ID of the bastion host.	bastionhost-cn-78v1ghxxxxx
	string	No	The ID of the bastion host.	2
Tag	array<object>	No	The tags of the bastion host.
	object	No	The tags of the bastion host.
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 returned.	4
RequestId	string	The request ID. Alibaba Cloud generates this unique ID to help troubleshoot issues.	61D36C55-AAFC-4678-8FAD-34FEF9E7182E
Instances	array<object>	The returned 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 custom description of the Bastionhost instance.	测试API
ExpireTime	integer	The expiration time of the Bastionhost instance, specified as a UNIX timestamp in 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, specified as a UNIX timestamp in 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 has 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.