调用DescribeInstances接口查询堡垒机实例的列表信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeInstances |
要执行的操作。取值:DescribeInstances。 |
PageNumber | Integer | 否 | 1 |
设置从返回结果的第几页开始显示查询结果。默认值为1,表示从第1页开始显示。 |
PageSize | Integer | 否 | 10 |
设置分页查询时,每页显示的堡垒机实例的数量。默认值为10,表示每页显示10条堡垒机实例信息。 |
RegionId | String | 否 | cn-hangzhou |
实例所在的地域ID。 |
InstanceStatus | String | 否 | RUNNING |
堡垒机实例的状态。取值:
|
ResourceGroupId | String | 否 | rg-acfm26ougi**** |
堡垒机实例所在的企业资源组的ID。 |
InstanceId.N | String | 否 | 2 |
堡垒机实例的ID。 |
Tag.N.Key | String | 否 | test |
实例的标签键。 |
Tag.N.Value | String | 否 | testapi |
实例的标签值。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
TotalCount | Long | 4 |
查询到的堡垒机实例的总数量。 |
RequestId | String | 61D36C55-AAFC-4678-8FAD-34FEF9E7182E |
本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。 |
Instances | Array of Instance |
查询到的堡垒机实例的列表。 |
|
VpcId | String | vpc-bp1c85tzgqu1bf5b**** |
堡垒机实例绑定的VPC ID。 |
VswitchId | String | vsw-bp1xfwzzfti0kjbf**** |
堡垒机实例绑定的交换机ID。 |
ImageVersion | String | 3.0.0 |
堡垒机实例镜像的版本。 |
PlanCode | String | cloudbastion_ha |
堡垒机实例的规格。取值:
|
Description | String | 测试API |
堡垒机实例的备注信息。 |
ExpireTime | Long | 1578326400000 |
堡垒机实例的到期的时间戳。单位为毫秒。 |
Legacy | Boolean | false |
该堡垒机实例是否为旧版堡垒机实例。取值:
|
InstanceId | String | bastionhost-cn-78v1gh**** |
堡垒机的实例ID。 |
InternetEndpoint | String | drawvxalwb-public.bastionhost.aliyuncs.com |
堡垒机实例的公网域名。 |
RegionId | String | cn-hangzhou |
堡垒机实例所在的地域ID。 |
IntranetEndpoint | String | drawvxalwb.bastionhost.aliyuncs.com |
堡垒机实例的私网域名。 |
StartTime | Long | 1577681345000 |
堡垒机实例的购买或续费的时间戳。单位为毫秒。 |
ResourceGroupId | String | g-acfm26ougi**** |
堡垒机实例所在的企业资源组的ID。 |
InstanceStatus | String | RUNNING |
堡垒机实例的状态。取值:
|
LicenseCode | String | bhah_ent_50_asset |
堡垒机实例的许可Code。 |
PublicNetworkAccess | Boolean | true |
公网是否可以访问该堡垒机实例。取值:
|
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeInstances
&PageNumber=1
&PageSize=10
&RegionId=cn-hangzhou
&InstanceStatus=RUNNING
&ResourceGroupId=rg-acfm26ougi****
&InstanceId=["2"]
&Tag=[{"Key":"test","Value":"testapi"}]
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeInstancesResponse>
<TotalCount>4</TotalCount>
<RequestId>61D36C55-AAFC-4678-8FAD-34FEF9E7182E</RequestId>
<Instances>
<VpcId>vpc-bp1c85tzgqu1bf5b****</VpcId>
<VswitchId>vsw-bp1xfwzzfti0kjbf****</VswitchId>
<ImageVersion>3.0.0</ImageVersion>
<PlanCode>cloudbastion_ha</PlanCode>
<Description>测试API</Description>
<ExpireTime>1578326400000</ExpireTime>
<Legacy>false</Legacy>
<InstanceId>bastionhost-cn-78v1gh****</InstanceId>
<InternetEndpoint>drawvxalwb-public.bastionhost.aliyuncs.com</InternetEndpoint>
<RegionId>cn-hangzhou</RegionId>
<IntranetEndpoint>drawvxalwb.bastionhost.aliyuncs.com</IntranetEndpoint>
<StartTime>1577681345000</StartTime>
<ResourceGroupId>g-acfm26ougi****</ResourceGroupId>
<InstanceStatus>RUNNING</InstanceStatus>
<LicenseCode>bhah_ent_50_asset</LicenseCode>
<PublicNetworkAccess>true</PublicNetworkAccess>
</Instances>
</DescribeInstancesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalCount" : 4,
"RequestId" : "61D36C55-AAFC-4678-8FAD-34FEF9E7182E",
"Instances" : [ {
"VpcId" : "vpc-bp1c85tzgqu1bf5b****",
"VswitchId" : "vsw-bp1xfwzzfti0kjbf****",
"ImageVersion" : "3.0.0",
"PlanCode" : "cloudbastion_ha",
"Description" : "测试API",
"ExpireTime" : 1578326400000,
"Legacy" : false,
"InstanceId" : "bastionhost-cn-78v1gh****",
"InternetEndpoint" : "drawvxalwb-public.bastionhost.aliyuncs.com",
"RegionId" : "cn-hangzhou",
"IntranetEndpoint" : "drawvxalwb.bastionhost.aliyuncs.com",
"StartTime" : 1577681345000,
"ResourceGroupId" : "g-acfm26ougi****",
"InstanceStatus" : "RUNNING",
"LicenseCode" : "bhah_ent_50_asset",
"PublicNetworkAccess" : true
} ]
}
错误码
访问错误中心查看更多错误码。