调用DescribeInstanceAttribute查询实例所有的属性信息,例如:实例ID、实例的备注信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeInstanceAttribute

要执行的操作。

取值:DescribeInstanceAttribute。

InstanceId String bastionhost-cn-78v1ghxxxxx

堡垒机的实例ID。

RegionId String cn-hangzhou

地域ID。

返回数据

名称 类型 示例值 描述
RequestId String 082FAB35-6AB9-4FD5-8750-D36673548E76

请求ID。

InstanceAttribute Struct

实例属性信息。

InstanceId String bastionhost-cn-78v1ghxxxxx

实例ID。

InstanceStatus String RUNNING

实例状态。取值范围:

  • PENDING:未初始化
  • CREATING:创建中
  • RUNNING:运行中
  • EXPIRED:已过期
  • CREATE_FAILED:创建失败
  • UPGRADING:变配中
  • UPGRADE_FAILED:变配失败
VpcId String vpc-bp1c85tzgqu1bf5bxxxxx

实例绑定的VPC ID。

VswitchId String vsw-bp1xfwzzfti0kjbfxxxxx

实例绑定的交换机ID。

IntranetEndpoint String drawvxalwb.bastionhost.aliyuncs.com

私网域名。

InternetEndpoint String drawvxalwb-public.bastionhost.aliyuncs.com

公网域名。

PublicNetworkAccess Boolean true

公网是否可访问该堡垒机。

EniInstanceId String eni-bp1455jrzwm7moaxxxxx

弹性网卡ID。

StartTime Long 1577681345000

实例的开始时间。

ExpireTime Long 1578326400000

过期时间。

Description String 测试API

备注信息。

LicenseCode String bhah_ent_50_asset

许可Code。

PublicWhiteList List [10.162.168.xx/32]

公网白名单IP列表。

PrivateWhiteList List []

私网白名单IP列表。

SecurityGroupIds List []

实例所属安全组ID列表。

AuthorizedSecurityGroups List [sg-bp14u00sh39jvw5xxxxx]

已授权的安全组ID列表。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeInstanceAttribute
&InstanceId=bastionhost-cn-78v1ghxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>082FAB35-6AB9-4FD5-8750-D36673548E76</RequestId>
<InstanceAttribute>
    <LicenseCode>bhah_ent_50_asset</LicenseCode>
    <Description>测试API</Description>
    <InstanceId>bastionhost-cn-78v1ghxxxxx</InstanceId>
    <StartTime>1577681345000</StartTime>
    <VswitchId>vsw-bp1xfwzzfti0kjbfxxxxx</VswitchId>
    <PublicWhiteList>10.162.168.xx/32</PublicWhiteList>
    <VpcId>vpc-bp1c85tzgqu1bf5bxxxxx</VpcId>
    <PublicNetworkAccess>true</PublicNetworkAccess>
    <AuthorizedSecurityGroups>sg-bp14u00sh39jvw5xxxxx</AuthorizedSecurityGroups>
    <InstanceStatus>RUNNING</InstanceStatus>
    <EniInstanceId>eni-bp1455jrzwm7moaxxxxx</EniInstanceId>
    <InternetEndpoint>drawvxalwb-public.bastionhost.aliyuncs.com</InternetEndpoint>
    <ExpireTime>1578326400000</ExpireTime>
    <IntranetEndpoint>drawvxalwb.bastionhost.aliyuncs.com</IntranetEndpoint>
</InstanceAttribute>

JSON 格式

{
	"RequestId":"082FAB35-6AB9-4FD5-8750-D36673548E76",
	"InstanceAttribute":{
		"LicenseCode":"bhah_ent_50_asset",
        "Description":"测试API",
		"InstanceId":"bastionhost-cn-78v1ghxxxxx",
		"PrivateWhiteList":[],
		"StartTime":1577681345000,
		"SecurityGroupIds":[],
		"VswitchId":"vsw-bp1xfwzzfti0kjbfxxxxx",
		"PublicWhiteList":[
			"10.162.168.xx/32"
		],
		"VpcId":"vpc-bp1c85tzgqu1bf5bxxxxx",
		"PublicNetworkAccess":true,
		"AuthorizedSecurityGroups":[
			"sg-bp14u00sh39jvw5xxxxx"
		],
		"InstanceStatus":"RUNNING",
		"EniInstanceId":"eni-bp1455jrzwm7moaxxxxx",
		"InternetEndpoint":"drawvxalwb-public.bastionhost.aliyuncs.com",
		"ExpireTime":1578326400000,
		"IntranetEndpoint":"drawvxalwb.bastionhost.aliyuncs.com"
	}
}

错误码

访问错误中心查看更多错误码。