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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-bastionhost:DescribeInstanceAttribute	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-hangzhou
InstanceId	string	Yes	The ID of the Bastionhost instance.	bastionhost-cn-78v1ghxxxxx

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	082FAB35-6AB9-4FD5-8750-D36673548E76
InstanceAttribute	object	The attribute information about the bastion host.
VpcId	string	The ID of the VPC to which the instance belongs.	vpc-bp1c85tzgqu1bf5bxxxxx
VswitchId	string	The ID of the vSwitch to which the instance connects.	vsw-bp1xfwzzfti0kjbfxxxxx
Description	string	The description of the instance.
ExpireTime	long	The time when the instance 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 instance.	bastionhost-cn-78v1ghxxxxx
InternetEndpoint	string	The public endpoint.	drawvxalwb-public.bastionhost.aliyuncs.com
RegionId	string	The region ID of the instance.	cn-hangzhou
IntranetEndpoint	string	The private endpoint.	drawvxalwb.bastionhost.aliyuncs.com
StartTime	long	The time when the instance started.	1577681345000
ResourceGroupId	string	The ID of the resource group to which the instance 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 instance. Valid values: PENDING: The instance is not initialized. CREATING: The instance is being created. RUNNING: The instance is running. EXPIRED: The instance expired. CREATE_FAILED: The instance fails to be created. UPGRADING: The configurations of the instance are being changed. UPGRADE_FAILED: The configurations of the instance fail to be changed.	RUNNING
LicenseCode	string	The license code.	bhah_ent_50_asset
PublicNetworkAccess	boolean	Indicates whether the Bastionhost instance can be accessed over the Internet.	true
Storage	long	The storage capacity of the bastion host. Unit: bytes.	2199023255552
Ports	array<object>	An array that consists of the O&M ports of the bastion host.
Port	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 Only the SSH and RDP ports can be changed. If no custom O&M port is specified for the bastion host, the value of StandardPort is returned.	600xx
PublicExportIps	array	An array that consists of the egress public IP addresses of the bastion host.
PublicExportIp	string	The egress public IP address of the bastion host.	[10.162.168.xx/32]
PublicWhiteList	array	The public IP addresses that are allowed to access the instance.
Cidr	string	An array that consists of public IP addresses in a whitelist for the bastion host.	[10.162.168.xx/32]
AuthorizedSecurityGroups	array	The IDs of authorized security groups.
AuthorizedSecurityGroup	string	The IDs of authorized security group.	[sg-bp14u00sh39jvw5xxxxx]
PrivateExportIps	array	An array that consists of the egress private IP addresses of the bastion host.
PrivateExportIp	string	The egress private IP address of the bastion host.	192.168.xx.xx
PublicIps	array	The public IP address.
PublicIp	string	The public IP address.	116.62.xx.xx
SecurityGroupIds	array	The IDs of the security groups to which the instance belongs.
SecurityGroupId	string	The IDs of the security groups.	sg-bp15ed6xe1yxeycg7o****
PrivateWhiteList	array	The private IP addresses that are allowed to access the instance.
PrivateIp	string	The private IP address that is added to the whitelist of the bastion host.	192.168.xx.xx
Bandwidth	string	The total bandwidth of the bastion host.	30
BandwidthPackage	string	The bandwidth plan ID.	5

Examples

Sample success responses

JSONformat

{
  "RequestId": "082FAB35-6AB9-4FD5-8750-D36673548E76",
  "InstanceAttribute": {
    "VpcId": "vpc-bp1c85tzgqu1bf5bxxxxx",
    "VswitchId": "vsw-bp1xfwzzfti0kjbfxxxxx",
    "Description": "",
    "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"
    ],
    "Bandwidth": "30",
    "BandwidthPackage": "5"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-07-18	The response structure of the API has changed	View Change Details