Use DescribeInstanceAttribute to query instance attributes - Bastionhost - Alibaba Cloud - Bastionhost

Queries all attribute information of an instance, such as the instance ID and instance description.

Operation description

You can call this operation to purchase an Encryption Service instance. This is a prepaid product, and the operation synchronously deducts the payment.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-bastionhost:DescribeInstanceAttribute

get

*Instance

acs:yundun-bastionhost:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the bastion host instance to query.	cn-hangzhou
InstanceId	string	Yes	The ID of the bastion host instance to query. Note You can call the DescribeInstances operation to obtain the bastion host instance ID.	bastionhost-cn-78v1ghxxxxx

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID. Alibaba Cloud generates a unique identifier for each API request. You can use this ID to troubleshoot issues.	082FAB35-6AB9-4FD5-8750-D36673548E76
InstanceAttribute	object	The instance attribute information.
VpcId	string	The VPC ID bound to the instance.	vpc-bp1c85tzgqu1bf5bxxxxx
VswitchId	string	The vSwitch ID bound to the instance.	vsw-bp1xfwzzfti0kjbfxxxxx
Description	string	The description of the instance.	TestAPI
ExpireTime	integer	The expiration timestamp of the bastion host instance. Unit: milliseconds.	1578326400000
ModifyPasswordModule	string	The status of the password change task feature. Enable: Enabled. Disable: Disabled.	Enable
EniInstanceId	string	The ID of the elastic network interfaces (ENIs). This is the network interface controller (NIC) ID bound to the instance.	eni-bp1455jrzwm7moaxxxxx
InstanceId	string	The instance ID.	bastionhost-cn-78v1ghxxxxx
InternetEndpoint	string	The public domain name.	******lwb-public.bastionhost.aliyuncs.com
RegionId	string	The region ID of the instance.	cn-hangzhou
IntranetEndpoint	string	The internal domain name.	******xalwb.bastionhost.aliyuncs.com
StartTime	integer	The timestamp when the bastion host instance was purchased or renewed. Unit: milliseconds.	1577681345000
ResourceGroupId	string	The ID of the resource group to which the instance belongs.	rg-aekzc427db******
NetworkProxyModule	string	The network domain proxy status. Enable: Network domain proxy mode is supported. Disable: Network domain proxy mode is not supported.	Enable
WebTerminalModule	string	The Web Terminal status. Enable: Web remote connection is supported. Disable: Web remote connection is not supported.	Enable
InstanceStatus	string	The instance status. Valid values: PENDING: Not initialized. CREATING: Being created. RUNNING: Running. EXPIRED: Expired. CREATE_FAILED: Creation failed. UPGRADING: Being upgraded. UPGRADE_FAILED: Upgrade failed.	RUNNING
LicenseCode	string	The license code.	bhah_ent_50_asset
PublicNetworkAccess	boolean	Indicates whether the bastion host instance is accessible over the Internet. Valid values: true: The bastion host is accessible over the Internet. false: The bastion host is not accessible over the Internet.	true
Storage	integer	The total storage capacity of the purchased bastion host. Unit: bytes.	2199023255552
Ports	array<object>	The O&M ports of the bastion host.
	object	The O&M ports 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 defined by the user. Note Only SSH and RDP ports can be modified. If no custom O&M port is configured for the bastion host, the value is the same as the standard port.	600xx
PublicExportIps	array	The list of public egress IP addresses of the bastion host.
	string	The public egress IP address of the bastion host.	[10.162.168.xx/32]
PublicWhiteList	array	The public whitelist of the bastion host.
	string	The IP address in the public whitelist of the bastion host.	[10.162.168.xx/32]
AuthorizedSecurityGroups	array	The list of authorized security group IDs.
	string	The authorized security group ID.	[sg-bp14u00sh39jvw5xxxxx]
PrivateExportIps	array	The list of internal egress IP addresses of the bastion host.
	string	The internal egress IP address of the bastion host.	192.168.xx.xx
PublicIps	array	The list of public IP addresses of the bastion host.
	string	The public IP address of the bastion host.	116.62.xx.xx
SecurityGroupIds	array	The list of security group IDs to which the instance belongs.
	string	The security group ID to which the instance belongs.	sg-bp15ed6xe1yxeycg7o****
PrivateWhiteList	array	The list of internal whitelist IP addresses.
	string	The internal whitelist IP address.	192.168.xx.xx
Bandwidth	string	The total bandwidth of the bastion host instance.	30
BandwidthPackage	string	The extended bandwidth package of the bastion host.	5
DbOperationModule	string	The database O&M status. Enable: Database O&M is supported. Disable: Database O&M is not supported.	Disable
RouterRules	array	The list of rules for the bastion host instance.
	string	The list of rules for the bastion host instance.
IDaaSModule	string	The IDaaS integration module. Valid values: Enable (enabled) and Disable (disabled).	Enable
SlaveVswitchId	string	The ID of the secondary vSwitch bound to the bastion host instance.	vsw-uf6cmnae7hu5****
ScriptDeliverModule	string	The script O&M module. Valid values: Enable (enabled) and Disable (disabled).	Enable
KmsSecretModule	string	The KMS Secrets Manager integration module. Valid values: Enable (enabled) and Disable (disabled).	Enable
RDModule	string	The multi-account module. Valid values: Enable (enabled) and Disable (disabled).	Enable
HSMModule	string	The HSM hardware encryption module status. Indicates whether the bastion host is integrated with HSM.
WhiteListPolicies	array<object>	The IP address whitelist to configure.
	object	The IP address whitelist to configure.
Entry	string	The IP address whitelist to configure. A maximum of 50 IP addresses are supported. Separate multiple IP addresses with commas (,).	94.74.xx.xx/32
Description	string	The description of the whitelist rule.	description
AppOperationModule	string	The application O&M module. Valid values: Enable (enabled) and Disable (disabled).	Enable
AiOpsModule	string	The intelligent O&M module switch (Enable/Disable).
AiCreditStatus	string	The AI credit status (Available/Exhausted).

Examples

Success response

JSON format

{
  "RequestId": "082FAB35-6AB9-4FD5-8750-D36673548E76",
  "InstanceAttribute": {
    "VpcId": "vpc-bp1c85tzgqu1bf5bxxxxx",
    "VswitchId": "vsw-bp1xfwzzfti0kjbfxxxxx",
    "Description": "Test 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",
    "AiOpsModule": "",
    "AiCreditStatus": ""
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.