All Products
Search
Document Center

Bastionhost:DescribeInstanceAttribute

更新時間:Nov 27, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-bastionhost:DescribeInstanceAttributeget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The ID of the region.

cn-hangzhou
InstanceIdstringYes

The ID of the Bastionhost instance.

bastionhost-cn-78v1ghxxxxx

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

082FAB35-6AB9-4FD5-8750-D36673548E76
InstanceAttributeobject

The attribute information about the bastion host.

VpcIdstring

The ID of the VPC to which the instance belongs.

vpc-bp1c85tzgqu1bf5bxxxxx
VswitchIdstring

The ID of the vSwitch to which the instance connects.

vsw-bp1xfwzzfti0kjbfxxxxx
Descriptionstring

The description of the instance.

ExpireTimelong

The time when the instance expires.

1578326400000
ModifyPasswordModulestring

The status of the automatic password change feature.

  • Enable
  • Disable
Enable
EniInstanceIdstring

The ID of the Elastic Network Interface (ENI).

eni-bp1455jrzwm7moaxxxxx
InstanceIdstring

The ID of the instance.

bastionhost-cn-78v1ghxxxxx
InternetEndpointstring

The public endpoint.

drawvxalwb-public.bastionhost.aliyuncs.com
RegionIdstring

The region ID of the instance.

cn-hangzhou
IntranetEndpointstring

The private endpoint.

drawvxalwb.bastionhost.aliyuncs.com
StartTimelong

The time when the instance started.

1577681345000
ResourceGroupIdstring

The ID of the resource group to which the instance belongs.

rg-aekzc427dbl2shy
NetworkProxyModulestring

The status of the network domain feature.

  • Enable
  • Disable
Enable
WebTerminalModulestring

The status of the web terminal.

  • Enable
  • Disable
Enable
DbOperationModulestring

The status of the database O&M feature.

Disable
InstanceStatusstring

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
LicenseCodestring

The license code.

bhah_ent_50_asset
PublicNetworkAccessboolean

Indicates whether the Bastionhost instance can be accessed over the Internet.

true
Storagelong

The storage capacity of the bastion host. Unit: bytes.

2199023255552
Portsarray<object>

An array that consists of the O&M ports of the bastion host.

Portobject

The O&M port of the bastion host.

StandardPortinteger

The standard port of the bastion host. Valid values:

  • SSH: 60022.
  • RDP: 63389.
  • HTTPS: 443.
60022
CustomPortinteger

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
PublicExportIpsarray

An array that consists of the egress public IP addresses of the bastion host.

PublicExportIpstring

The egress public IP address of the bastion host.

[10.162.168.xx/32]
PublicWhiteListarray

The public IP addresses that are allowed to access the instance.

Cidrstring

An array that consists of public IP addresses in a whitelist for the bastion host.

[10.162.168.xx/32]
AuthorizedSecurityGroupsarray

The IDs of authorized security groups.

AuthorizedSecurityGroupstring

The IDs of authorized security group.

[sg-bp14u00sh39jvw5xxxxx]
PrivateExportIpsarray

An array that consists of the egress private IP addresses of the bastion host.

PrivateExportIpstring

The egress private IP address of the bastion host.

192.168.xx.xx
PublicIpsarray

The public IP address.

PublicIpstring

The public IP address.

116.62.xx.xx
SecurityGroupIdsarray

The IDs of the security groups to which the instance belongs.

SecurityGroupIdstring

The IDs of the security groups.

sg-bp15ed6xe1yxeycg7o****
PrivateWhiteListarray

The private IP addresses that are allowed to access the instance.

PrivateIpstring

The private IP address that is added to the whitelist of the bastion host.

192.168.xx.xx
Bandwidthstring

The total bandwidth of the bastion host.

30
BandwidthPackagestring

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 timeSummary of changesOperation
2023-07-18The response structure of the API has changedView Change Details