DescribeInstanceAttribute - Bastionhost - Alibaba Cloud Documentation Center

Queries the attribute information about the specified bastion host. The information includes the ID and remarks of the bastion host.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the bastion host to query.	cn-hangzhou
InstanceId	string	Yes	The ID of the bastion host to query.	bastionhost-cn-78v1ghxxxxx

Response parameters

Parameter	Type	Description	Example
	object	The responses parameters.
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	082FAB35-6AB9-4FD5-8750-D36673548E76
InstanceAttribute	object	The attribute information about the bastion host.
VpcId	string	The ID of the virtual private cloud (VPC) to which the bastion host belongs.	vpc-bp1c85tzgqu1bf5bxxxxx
VswitchId	string	The ID of the vSwitch to which the bastion host belongs.	vsw-bp1xfwzzfti0kjbfxxxxx
Description	string	The remarks of the bastion host.	Test API
ExpireTime	long	The time when the bastion host expires.	1578326400000
ModifyPasswordModule	string	The status of the automatic password change feature. Enable Disable	Enable
EniInstanceId	string	The ID of the elastic network interface (ENI).	eni-bp1455jrzwm7moaxxxxx
InstanceId	string	The ID of the bastion host.	bastionhost-cn-78v1ghxxxxx
InternetEndpoint	string	The public endpoint of the bastion host.	drawvxalwb-public.bastionhost.aliyuncs.com
RegionId	string	The ID of the region in which the bastion host resides.	cn-hangzhou
IntranetEndpoint	string	The internal endpoint of the bastion host.	drawvxalwb.bastionhost.aliyuncs.com
StartTime	long	The time when the bastion host was purchased.	1577681345000
ResourceGroupId	string	The ID of the resource group to which the bastion host belongs.	rg-aekzc427dbl2shy
NetworkProxyModule	string	The status of the network domain feature. Enable Disable	Enable
WebTerminalModule	string	The status of the web terminal. Enable Disable	Enable
DbOperationModule	string	The status of the database O&M feature.	Disable
InstanceStatus	string	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 configurations of the bastion host are being changed. UPGRADE_FAILED: The configurations of the bastion host fail to be changed.	RUNNING
LicenseCode	string	The license code.	bhah_ent_50_asset
PublicNetworkAccess	boolean	Indicates whether the bastion host can be accessed over the Internet.	true
Storage	long	The storage capacity of the bastion host.	2199023255552
Ports	array	An array that consists of the O&M ports of the bastion host.
	object	The O&M port of the bastion host.
StandardPort	integer	The standard port of the bastion host. Valid values: SSH: 60022 RDP: 63389 HTTPS: 443	60022
CustomPort	integer	The custom port. Note: You can change only the SSH and RDP ports. If O&M ports are not specified, the value of the StandardPort parameter is returned.	600xx
PublicExportIps	array	An array that consists of the egress public IP addresses of the bastion host.
	string	The egress public IP address of the bastion host.	[10.162.168.xx/32]
PublicWhiteList	array	An array that consists of public IP addresses in a whitelist for the bastion host.
	string	The public IP address that is added to the whitelist of the bastion host.	[10.162.168.xx/32]
AuthorizedSecurityGroups	array	An array that consists of the IDs of authorized security groups.
	string	The ID of the authorized security group.	[sg-bp14u00sh39jvw5xxxxx]
PrivateExportIps	array	An array that consists of the egress private IP addresses of the bastion host.
	string	The egress private IP address of the bastion host.	192.168.xx.xx
PublicIps	array	An array that consists of the public IP addresses of the bastion host.
	string	The public IP address of the bastion host.	116.62.xx.xx
SecurityGroupIds	array	An array that consists of the IDs of the security groups to which the bastion host belongs.
	string	The ID of the security group to which the bastion host belongs.	sg-bp15ed6xe1yxeycg7o****
PrivateWhiteList	array	An array that consists of private IP addresses in a whitelist for the bastion host.
	string	The private IP address that is added to the whitelist of the bastion host.	192.168.xx.xx

Example

Normal return example

JSONFormat

{
  "RequestId": "082FAB35-6AB9-4FD5-8750-D36673548E76",
  "InstanceAttribute": {
    "VpcId": "vpc-bp1c85tzgqu1bf5bxxxxx",
    "VswitchId": "vsw-bp1xfwzzfti0kjbfxxxxx",
    "Description": "Test API\n",
    "ExpireTime": 1578326400000,
    "ModifyPasswordModule": "Enable",
    "EniInstanceId": "eni-bp1455jrzwm7moaxxxxx",
    "InstanceId": "bastionhost-cn-78v1ghxxxxx",
    "InternetEndpoint": "drawvxalwb-public.bastionhost.aliyuncs.com",
    "RegionId": "cn-hangzhou",
    "IntranetEndpoint": "drawvxalwb.bastionhost.aliyuncs.com",
    "StartTime": 1577681345000,
    "ResourceGroupId": "rg-aekzc427dbl2shy",
    "NetworkProxyModule": "Enable",
    "WebTerminalModule": "Enable",
    "DbOperationModule": "Disable",
    "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"
    ]
  }
}

Error codes

For a list of error codes, visit the API error center.