DescribeInstanceAttribute-阿里云帮助中心

Returns all instance attributes, such as its instance 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 in which the Bastionhost instance resides.	cn-hangzhou
InstanceId	string	Yes	The ID of the Bastionhost instance. 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 of 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 instance's Virtual Private Cloud (VPC).	vpc-bp1c85tzgqu1bf5bxxxxx
VswitchId	string	The ID of the instance's VSwitch.	vsw-bp1xfwzzfti0kjbfxxxxx
Description	string	The description of the instance.	测试API
ExpireTime	integer	The expiration timestamp, in milliseconds, of the Bastionhost instance.	1578326400000
ModifyPasswordModule	string	The status of the password change feature. 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 of the instance.	******lwb-public.bastionhost.aliyuncs.com
RegionId	string	The ID of the region where the Bastionhost instance is located.	cn-hangzhou
IntranetEndpoint	string	The internal endpoint of the instance.	******xalwb.bastionhost.aliyuncs.com
StartTime	integer	The timestamp, in milliseconds, when the Bastionhost instance was purchased or renewed.	1577681345000
ResourceGroupId	string	The ID of the instance's resource group.	rg-aekzc427db******
NetworkProxyModule	string	The status of the network domain proxy feature. Enable: The network domain proxy feature is enabled. Disable: The network domain proxy feature is disabled.	Enable
WebTerminalModule	string	The status of the web terminal. Enable: Supports web-based remote connections. Disable: Does not support web-based remote connections.	Enable
InstanceStatus	string	The status of the instance. Valid values: PENDING: The instance is being initialized. CREATING: The instance is being created. RUNNING: The instance is running. EXPIRED: The instance has expired. CREATE_FAILED: Instance creation failed. UPGRADING: The instance is being upgraded. UPGRADE_FAILED: Instance upgrade failed.	RUNNING
LicenseCode	string	The license code.	bhah_ent_50_asset
PublicNetworkAccess	boolean	Indicates whether the Bastionhost instance is accessible over the public network. Valid values: true: The Bastionhost instance is accessible over the public network. false: The Bastionhost instance is not accessible over the public network.	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 number. The following are the default standard ports for specific protocols: SSH: 60022 RDP: 63389 HTTPS: 443	60022
CustomPort	integer	The custom O&M port. Note Only SSH and RDP ports can be customized. If no custom port is set, this parameter returns the value of the `StandardPort` parameter.	600xx
PublicExportIps	array	A list of public egress IP addresses of the Bastionhost instance.
	string	A public egress IP address.	[10.162.168.xx/32]
PublicWhiteList	array	The public whitelist of the Bastionhost instance.
	string	An IP address on the public whitelist.	[10.162.168.xx/32]
AuthorizedSecurityGroups	array	A list of authorized security group IDs.
	string	The ID of an authorized security group.	[sg-bp14u00sh39jvw5xxxxx]
PrivateExportIps	array	A list of private egress IP addresses of the Bastionhost instance.
	string	A private egress IP address.	192.168.xx.xx
PublicIps	array	A list of public IP addresses of the Bastionhost instance.
	string	A public IP address.	116.62.xx.xx
SecurityGroupIds	array	A list of the instance's security group IDs.
	string	The ID of a security group that contains the instance.	sg-bp15ed6xe1yxeycg7o****
PrivateWhiteList	array	The private whitelist of 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 extra bandwidth package of the Bastionhost instance, in Mbit/s.	5
DbOperationModule	string	The status of the database O&M feature. Enable: The database O&M feature is enabled. Disable: The database O&M feature is disabled.	Disable
RouterRules	array	A list of routing rules for the Bastionhost instance.
	string
IDaaSModule	string	Indicates whether the IDaaS integration module is enabled. Valid values are `Enable` and `Disable`.	Enable
SlaveVswitchId	string	The ID of the standby VSwitch for the Bastionhost instance.	vsw-uf6cmnae7hu5****
ScriptDeliverModule	string	Indicates whether the script-based O&M module is enabled. Valid values are `Enable` and `Disable`.	Enable
KmsSecretModule	string	Indicates whether the instance is integrated with Key Management Service (KMS) and Secrets Manager. Valid values are `Enable` and `Disable`.	Enable
RDModule	string	Indicates whether the multi-account module is enabled. Valid values are `Enable` and `Disable`.	Enable
HSMModule	string	Indicates whether the Bastionhost instance is integrated with a Hardware Security Module (HSM).
WhiteListPolicies	array<object>	The configured IP address whitelist policies.
	object
Entry	string	An IP address or CIDR block in the whitelist.	94.74.xx.xx/32
Description	string	The description of the whitelist rule.	description
AppOperationModule	string	Indicates whether the application O&M module is enabled. Valid values are `Enable` and `Disable`.	Enable

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": "Enable",
    "SlaveVswitchId": "vsw-uf6cmnae7hu5****",
    "ScriptDeliverModule": "Enable",
    "KmsSecretModule": "Enable",
    "RDModule": "Enable",
    "HSMModule": "",
    "WhiteListPolicies": [
      {
        "Entry": "94.74.xx.xx/32",
        "Description": "description"
      }
    ],
    "AppOperationModule": "Enable"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.