Use DescribeInstanceAttribute to query instance attributes - Bastionhost

Returns all attributes of an instance, such as its ID and description.

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
RegionId	string	No	The ID of the region where the Bastionhost instance is located.	cn-hangzhou
InstanceId	string	Yes	The ID of the Bastionhost instance to query. Note You can call the DescribeInstances operation to obtain the ID of the Bastionhost instance.	bastionhost-cn-78v1ghxxxxx

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The unique ID generated for the request. You can use this ID to troubleshoot issues.	082FAB35-6AB9-4FD5-8750-D36673548E76
InstanceAttribute	object	The attributes of the instance.
VpcId	string	The ID of the VPC to which the instance is attached.	vpc-bp1c85tzgqu1bf5bxxxxx
VswitchId	string	The ID of the vSwitch to which the instance is attached.	vsw-bp1xfwzzfti0kjbfxxxxx
Description	string	The description of the instance.	测试API
ExpireTime	integer	The expiration timestamp of the Bastionhost instance, in milliseconds.	1578326400000
ModifyPasswordModule	string	Indicates whether the password change feature is enabled. Valid values: Enable: The feature is enabled. Disable: The feature is disabled.	Enable
EniInstanceId	string	The ID of the elastic network interface (ENI).	eni-bp1455jrzwm7moaxxxxx
InstanceId	string	The ID of the instance.	bastionhost-cn-78v1ghxxxxx
InternetEndpoint	string	The public domain name.	******lwb-public.bastionhost.aliyuncs.com
RegionId	string	The ID of the region where the Bastionhost instance resides.	cn-hangzhou
IntranetEndpoint	string	The internal endpoint.	******xalwb.bastionhost.aliyuncs.com
StartTime	integer	The purchase or renewal timestamp of the Bastionhost instance, in milliseconds.	1577681345000
ResourceGroupId	string	The ID of the resource group to which the instance belongs.	rg-aekzc427db******
NetworkProxyModule	string	Indicates whether the network domain proxy feature is enabled. Valid values: Enable: The network domain proxy feature is enabled. Disable: The network domain proxy feature is disabled.	Enable
WebTerminalModule	string	Indicates whether the web terminal feature is enabled. Valid values: Enable: Allows web-based remote connections. Disable: Prevents web-based remote connections.	Enable
InstanceStatus	string	The status of the instance. Valid values: PENDING: Initializing CREATING: Creating RUNNING: Running EXPIRED: Expired CREATE_FAILED: Creation failed UPGRADING: Scaling UPGRADE_FAILED: Scaling failed	RUNNING
LicenseCode	string	The license code.	bhah_ent_50_asset
PublicNetworkAccess	boolean	Indicates whether the Bastionhost instance is publicly accessible. Valid values: true: The instance is publicly accessible. false: The instance is not publicly accessible.	true
Storage	integer	The total storage capacity of the Bastionhost instance, in bytes.	2199023255552
Ports	array<object>	The O&M ports of the Bastionhost instance.
	object	An O&M port of the Bastionhost instance.
StandardPort	integer	The standard O&M port. Valid values: SSH: 60022 RDP: 63389 HTTPS: 443	60022
CustomPort	integer	The custom O&M port. Note Only the SSH and RDP ports can be customized. If a custom port is not specified, this parameter returns the same value as `StandardPort`.	600xx
PublicExportIps	array	The public egress IP addresses of the Bastionhost instance.
	string	A public egress IP address.	[10.162.168.xx/32]
PublicWhiteList	array	The public whitelist for the Bastionhost instance.
	string	An IP address on the public whitelist.	[10.162.168.xx/32]
AuthorizedSecurityGroups	array	The IDs of the authorized security groups.
	string	The ID of an authorized security group.	[sg-bp14u00sh39jvw5xxxxx]
PrivateExportIps	array	The private egress IP addresses of the Bastionhost instance.
	string	A private egress IP address.	192.168.xx.xx
PublicIps	array	The public IP addresses of the Bastionhost instance.
	string	A public IP address.	116.62.xx.xx
SecurityGroupIds	array	The IDs of security groups to which the instance belongs.
	string	The ID of a security group to which the instance belongs.	sg-bp15ed6xe1yxeycg7o****
PrivateWhiteList	array	The private whitelist for the instance.
	string	An IP address on the private whitelist.	192.168.xx.xx
Bandwidth	string	The total bandwidth of the Bastionhost instance, in Mbit/s.	30
BandwidthPackage	string	The size of the extra bandwidth package, in Mbit/s.	5
DbOperationModule	string	Indicates whether the database O&M feature is enabled. Valid values: Enable: Database O&M is enabled. Disable: Database O&M is disabled.	Disable
RouterRules	array
	string
IDaaSModule	string
SlaveVswitchId	string
ScriptDeliverModule	string
KmsSecretModule	string
RDModule	string
HSMModule	string
WhiteListPolicies	array<object>
	object
Entry	string
Description	string
AppOperationModule	string

Examples

Success response

JSON format

{
  "RequestId": "082FAB35-6AB9-4FD5-8750-D36673548E76",
  "InstanceAttribute": {
    "VpcId": "vpc-bp1c85tzgqu1bf5bxxxxx",
    "VswitchId": "vsw-bp1xfwzzfti0kjbfxxxxx",
    "Description": "测试API",
    "ExpireTime": 1578326400000,
    "ModifyPasswordModule": "Enable",
    "EniInstanceId": "eni-bp1455jrzwm7moaxxxxx",
    "InstanceId": "bastionhost-cn-78v1ghxxxxx",
    "InternetEndpoint": "******lwb-public.bastionhost.aliyuncs.com",
    "RegionId": "cn-hangzhou",
    "IntranetEndpoint": "******xalwb.bastionhost.aliyuncs.com",
    "StartTime": 1577681345000,
    "ResourceGroupId": "rg-aekzc427db******",
    "NetworkProxyModule": "Enable",
    "WebTerminalModule": "Enable",
    "InstanceStatus": "RUNNING",
    "LicenseCode": "bhah_ent_50_asset",
    "PublicNetworkAccess": true,
    "Storage": 2199023255552,
    "Ports": [
      {
        "StandardPort": 60022,
        "CustomPort": 0
      }
    ],
    "PublicExportIps": [
      "[10.162.168.xx/32]"
    ],
    "PublicWhiteList": [
      "[10.162.168.xx/32]"
    ],
    "AuthorizedSecurityGroups": [
      "[sg-bp14u00sh39jvw5xxxxx]"
    ],
    "PrivateExportIps": [
      "192.168.xx.xx"
    ],
    "PublicIps": [
      "116.62.xx.xx"
    ],
    "SecurityGroupIds": [
      "sg-bp15ed6xe1yxeycg7o****"
    ],
    "PrivateWhiteList": [
      "192.168.xx.xx"
    ],
    "Bandwidth": "30",
    "BandwidthPackage": "5",
    "DbOperationModule": "Disable",
    "RouterRules": [
      ""
    ],
    "IDaaSModule": "",
    "SlaveVswitchId": "",
    "ScriptDeliverModule": "",
    "KmsSecretModule": "",
    "RDModule": "",
    "HSMModule": "",
    "WhiteListPolicies": [
      {
        "Entry": "",
        "Description": ""
      }
    ],
    "AppOperationModule": ""
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.