DescribeInstances
调用DescribeInstances查询一台或多台ECS实例的详细信息。
接口说明
- 请求参数的作用类似于一个过滤器,过滤器为逻辑与(AND)关系。如果某一参数为空,则过滤器不起作用。但是参数InstanceIds如果是一个空JSON数组,则视为该过滤器有效,且返回空。
- 如果您使用的是RAM用户账号或者RAM角色,当用户或者角色缺乏接口权限时,将会返回空列表。您可以在请求中加入
DryRun
参数,判断是否因权限问题导致的空列表现象。
通过阿里云CLI调用API时,不同数据类型的请求参数取值必须遵循格式要求,详情请参见CLI参数格式说明。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 否 | DescribeInstances |
系统规定参数。取值:DescribeInstances |
RegionId | String | 是 | cn-hangzhou |
实例所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。 |
InstanceIds | String | 否 | ["i-bp67acfmxazb4ph***", "i-bp67acfmxazb4pi***", … "i-bp67acfmxazb4pj***"] |
实例ID。取值可以由多个实例ID组成一个JSON数组,最多支持100个ID,ID之间用半角逗号(,)隔开。 |
VpcId | String | 否 | v-bp67acfmxazb4ph*** |
专有网络VPC ID。 |
VSwitchId | String | 否 | vsw-bp67acfmxazb4ph*** |
交换机ID。 |
InstanceNetworkType | String | 否 | vpc |
实例网络类型。取值范围:
|
SecurityGroupId | String | 否 | sg-bp67acfmxazb4ph*** |
实例所属的安全组。 |
ZoneId | String | 否 | cn-hangzhou-g |
可用区ID。 |
PageNumber | Integer | 否 | 1 |
实例状态列表的页码。 起始值:1。 默认值:1。 |
PageSize | Integer | 否 | 10 |
分页查询时设置的每页行数。 最大值:100。 默认值:10。 |
InnerIpAddresses | String | 否 | ["10.1.1.1", "10.1.2.1", … "10.1.10.1"] |
经典网络类型实例的内网IP列表。当InstanceNetworkType=classic时生效,取值可以由多个IP组成一个JSON数组,最多支持100个IP,IP之间用半角逗号(,)隔开。 |
PrivateIpAddresses | String | 否 | ["172.16.1.1", "172.16.2.1", … "172.16.10.1"] |
VPC网络类型实例的私有IP。当InstanceNetworkType=vpc时生效,取值可以由多个IP组成一个JSON数组,最多支持100个IP,IP之间用半角逗号(,)隔开。 |
PublicIpAddresses | String | 否 | ["42.1.1.**", "42.1.2.**", … "42.1.10.**"] |
实例的公网IP列表。当InstanceNetworkType=classic时生效,取值可以由多个IP组成一个JSON数组,最多支持100个IP,IP之间用半角逗号(,)隔开。 |
EipAddresses | String | 否 | ["42.1.1.**", "42.1.2.**", … "42.1.10.**"] |
实例的弹性公网IP列表。当InstanceNetworkType=vpc时该参数生效,取值可以由多个IP组成一个JSON数组,最多支持100个IP,IP之间用半角逗号(,)隔开。 |
InstanceChargeType | String | 否 | PostPaid |
实例的计费方式。取值范围:
|
InternetChargeType | String | 否 | PayByTraffic |
公网带宽计费方式。取值范围:
|
InstanceName | String | 否 | *Joshua |
实例名称,支持使用通配符*进行模糊搜索。 |
ImageId | String | 否 | m-bp67acfmxazb4ph*** |
镜像ID。 |
Status | String | 否 | Running |
实例状态。取值范围:
|
LockReason | String | 否 | security |
资源被锁定的原因。 |
IoOptimized | Boolean | 否 | true |
是否是I/O优化型实例。 |
Tag.N.Key | String | 否 | FinanceDept |
实例的标签键。N的取值范围:1~20。 |
Tag.N.Value | String | 否 | FinanceDeptJoshua |
实例的标签值。N的取值范围:1~20。 |
Tag.N.key | String | 否 | FinanceDept |
标签键。 说明 为提高兼容性,建议您尽量使用Tag.N.Key参数。
|
Tag.N.value | String | 否 | FinanceDeptJoshua |
标签值。 说明 为提高兼容性,建议您尽量使用Tag.N.Value参数。
|
InstanceType | String | 否 | ecs.g5.large |
实例的规格。 |
InstanceTypeFamily | String | 否 | ecs.g5 |
实例的规格族。 |
KeyPairName | String | 否 | FinanceJoshua |
实例使用的SSH密钥对名称。 |
ResourceGroupId | String | 否 | rg-bp67acfmxazb4ph*** |
实例所在的企业资源组ID。 |
HpcClusterId | String | 否 | hpc-bp67acfmxazb4ph*** |
实例所在的HPC集群ID。 |
RdmaIpAddresses | String | 否 | 10.10.10.102 |
HPC实例的Rdma网络IP。 |
DryRun | Boolean | 否 | false |
是否只预检此次请求。取值范围:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
请求ID。 |
TotalCount | Integer | 58 |
查询到的实例总数。 |
PageNumber | Integer | 1 |
实例列表的页码。 |
PageSize | Integer | 1 |
输入时设置的每页行数。 |
Instances | Array |
由Instances组成的数组格式,返回实例的信息。 |
|
InstanceId | String | i-bp67acfmxazb4ph*** |
实例ID。 |
InstanceName | String | FinanceJoshua |
实例名称。 |
Description | String | description |
实例描述。 |
ImageId | String | m-bp67acfmxazb4ph*** |
实例运行的镜像ID。 |
OSName | String | CentOS 7.4 64 位 |
实例的操作系统名称。 |
OSNameEn | String | CentOS 7.4 64 bit |
实例操作系统的英文名称。 |
OSType | String | linux |
实例的操作系统类型,分为Windows Server和Linux两种。可能值:
|
RegionId | String | cn-hangzhou |
实例所属地域ID。 |
ZoneId | String | cn-hangzhou-g |
实例所属可用区。 |
ClusterId | String | c-bp67acfmxazb4ph*** |
实例所在的集群ID。 说明 该参数即将被弃用,为提高兼容性,请尽量使用其他参数。
|
InstanceType | String | ecs.g5.large |
实例规格。 |
Cpu | Integer | 8 |
vCPU数。 |
Memory | Integer | 1024 |
内存大小,单位MiB。 |
HostName | String | JoshuaHost |
实例主机名。 |
DeploymentSetId | String | ds-bp67acfmxazb4ph*** |
部署集ID。 |
Status | String | Running |
实例状态。 |
SerialNumber | String | 51d1353b-22bf-4567-a176-8b3e12e43*** |
实例序列号。 |
InternetChargeType | String | PayByTraffic |
网络计费类型。可能值:
|
InternetMaxBandwidthIn | Integer | 100 |
公网入带宽最大值,单位为Mbit/s。 |
InternetMaxBandwidthOut | Integer | 5 |
公网出带宽最大值,单位为Mbit/s。 |
VlanId | String | 10 |
实例的VLAN ID。 说明 该参数即将被弃用,为提高兼容性,请尽量使用其他参数。
|
CreationTime | String | 2017-12-10T04:04Z |
实例创建时间。 |
StartTime | String | 2017-12-10T04:04Z |
实例的竞价模式开始时间。 |
InstanceNetworkType | String | vpc |
实例网络类型。可能值:
|
InstanceChargeType | String | PostPaid |
实例的计费方式。可能值:
|
SaleCycle | String | month |
实例计费周期。 |
ExpiredTime | String | 2017-12-10T04:04Z |
过期时间。按照ISO8601标准表示,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 |
AutoReleaseTime | String | 2017-12-10T04:04Z |
按量付费实例的自动释放时间。 |
IoOptimized | Boolean | true |
是否为I/O优化型实例。 |
DeviceAvailable | Boolean | true |
实例是否可以挂载数据盘。 |
InstanceTypeFamily | String | ecs.g5 |
实例规格族。 |
LocalStorageCapacity | Long | 1000 |
实例挂载的本地存储容量。 |
LocalStorageAmount | Integer | 2 |
实例挂载的本地存储数量。 |
GPUAmount | Integer | 4 |
实例规格附带的GPU数量。 |
GPUSpec | String | NVIDIA V100 |
实例规格附带的GPU类型。 |
SpotStrategy | String | NoSpot |
抢占式实例的抢占策略。可能值:
|
SpotPriceLimit | Float | 0.98 |
实例的每小时最高价格。支持最大3位小数,参数SpotStrategy=SpotWithPriceLimit时,该参数生效。 |
ResourceGroupId | String | rg-bp67acfmxazb4ph*** |
实例所属的企业资源组ID。 |
KeyPairName | String | FinanceJoshua |
密钥对名称。 |
Recyclable | Boolean | false |
实例是否可以回收。 |
HpcClusterId | String | hpc-bp67acfmxazb4ph*** |
实例所属的HPC集群ID。 |
StoppedMode | String | KeepCharging |
实例停机后是否继续收费。可能值:
|
CreditSpecification | String | Standard |
修改突发性能实例的运行模式。可能值: |
DeletionProtection | Boolean | false |
实例释放保护属性,指定是否支持通过控制台或API(DeleteInstance)释放实例。
说明 该属性仅适用于按量付费实例,且只能限制手动释放操作,对系统释放操作不生效。
|
NetworkInterfaces | Array |
实例包含的弹性网卡集合。 |
|
NetworkInterfaceId | String | eni-2zeh9atclduxvf1zc*** |
弹性网卡的ID。 |
MacAddress | String | 00:16:3e:32:b4:** |
弹性网卡的MAC地址。 |
PrimaryIpAddress | String | 172.17.**.*** |
弹性网卡主私有IP地址。 |
OperationLocks | Array |
实例的锁定原因。 |
|
LockReason | String | Recycling |
锁定类型。可能值:
|
LockMsg | String | The specified instance is locked due to financial reason. |
实例被锁定的描述信息。 |
Tags | Array |
实例的标签集合。 |
|
TagKey | String | FinanceDept |
实例的标签键。 |
TagValue | String | FinanceDept.Joshua |
实例的标签值。 |
SecurityGroupIds | List | sg-bp67acfmxazb4ph*** |
实例所属安全组集合。 |
PublicIpAddress | List | 121.40.61.*** |
实例公网IP地址。 |
InnerIpAddress | List | 10.170.**.*** |
实例的内网IP地址。 |
RdmaIpAddress | List | 10.10.10.102 |
HPC实例的Rdma网络IP。 |
VpcAttributes | Struct |
专有网络VPC属性。 |
|
VpcId | String | vpc-2zeuphj08tt7q3brdb*** |
专有网络VPC ID。 |
VSwitchId | String | vsw-2zeh0r1pabwtg6wcss*** |
虚拟交换机ID。 |
NatIpAddress | String | 172.17.**.*** |
云产品的IP,用于VPC云产品之间的网络互通。 |
PrivateIpAddress | List | 172.17.**.*** |
私有IP地址。 |
EipAddress | Struct |
弹性公网IP绑定信息。 |
|
AllocationId | String | i-bp67acfmxazb4ph*** |
弹性公网IP绑定的实例ID。 |
IpAddress | String | 42.112.17.** |
弹性公网IP。 |
Bandwidth | Integer | 5 |
弹性公网IP的公网带宽限速,单位为Mbit/s。 |
InternetChargeType | String | PayByTraffic |
弹性公网IP的计费方式。 |
IsSupportUnassociate | Boolean | true |
是否可以解绑弹性公网IP。 |
DedicatedHostAttribute | Struct |
由专有宿主机ID(DedicatedHostId)和名称(DedicatedHostName)组成的宿主机属性数组。 |
|
DedicatedHostId | String | dh-bp67acfmxazb4ph*** |
专有宿主机ID。 |
DedicatedHostName | String | FinanceDept |
专有宿主机名称。 |
EcsCapacityReservationAttr | Struct |
云服务器ECS的容量预留相关参数。 |
|
CapacityReservationId | String | cr-bp67acfmxazb4ph*** |
容量预留ID。 |
CapacityReservationPreference | String | cr-bp67acfmxazb4ph*** |
容量预留偏好。 |
DedicatedInstanceAttribute | Struct |
专有宿主机实例的属性。 |
|
Tenancy | String | default |
实例的宿主机类型是否为专有宿主机。可能值:
|
Affinity | String | default |
专有宿主机实例是否与专有宿主机关联。可能值:
|
CpuOptions | Struct |
CPU配置详情。 |
|
CoreCount | Integer | 2 |
物理CPU核心数。 |
ThreadsPerCore | Integer | 4 |
CPU线程数。 |
Numa | String | 2 |
分配的线程数。可能值:2。 |
示例
请求示例
https://ecs.aliyuncs.com/?Action=DescribeInstances
&RegionId=cn-hangzhou
&PageSize=1
PageNumber=1
&<公共请求参数>
正常返回示例
XML
格式
<DescribeInstancesResponse>
<PageNumber>1</PageNumber>
<TotalCount>6</TotalCount>
<PageSize>10</PageSize>
<RequestId>8EF01A45-FFFA-497B-B5C3-1DE1B74DB32D</RequestId>
<Instances>
<Instance>
<InnerIpAddress></InnerIpAddress>
<ImageId>ubuntu_16_0402_64_20G_alibase_20170818.vhd</ImageId>
<InstanceTypeFamily>ecs.g5</InstanceTypeFamily>
<VlanId></VlanId>
<NetworkInterfaces>
<NetworkInterface>
<MacAddress>00:16:3e:32:b4:dc</MacAddress>
<PrimaryIpAddress>172.17.XX.XXX</PrimaryIpAddress>
<NetworkInterfaceId>eni-2zeh9atclduxvf1zc***</NetworkInterfaceId>
</NetworkInterface>
</NetworkInterfaces>
<InstanceId>XXXXXXXXXXX</InstanceId>
<EipAddress>
<IpAddress></IpAddress>
<AllocationId></AllocationId>
<InternetChargeType></InternetChargeType>
</EipAddress>
<InternetMaxBandwidthIn>1000</InternetMaxBandwidthIn>
<ZoneId>cn-beijing-e</ZoneId>
<InternetChargeType>PayByBandwidth</InternetChargeType>
<SpotStrategy>NoSpot</SpotStrategy>
<StoppedMode>Not-applicable</StoppedMode>
<SerialNumber>d9bd1cdc-624d-4736-9da5-2ba2f741a***</SerialNumber>
<IoOptimized>true</IoOptimized>
<Memory>8192</Memory>
<Cpu>2</Cpu>
<VpcAttributes>
<NatIpAddress></NatIpAddress>
<PrivateIpAddress>
<IpAddress>172.17.XX.XXX</IpAddress>
</PrivateIpAddress>
<VSwitchId>vsw-2zeh0r1pabwtg6wcss***</VSwitchId>
<VpcId>vpc-2zeuphj08tt7q3brdb***</VpcId>
</VpcAttributes>
<InternetMaxBandwidthOut>1</InternetMaxBandwidthOut>
<SecurityGroupIds>
<SecurityGroupId>sg-2ze21r9qb638hvtrv***</SecurityGroupId>
</SecurityGroupIds>
<SpotPriceLimit>0.0</SpotPriceLimit>
<SaleCycle>Week</SaleCycle>
<AutoReleaseTime></AutoReleaseTime>
<InstanceName>ECS-BUY-2017-57-10</InstanceName>
<Description></Description>
<ResourceGroupId></ResourceGroupId>
<OSType>linux</OSType>
<OSName>Ubuntu 16.04 64</OSName>
<InstanceNetworkType>vpc</InstanceNetworkType>
<PublicIpAddress>
<IpAddress>47.94.XX.XX</IpAddress>
</PublicIpAddress>
<HostName>iZ2zeh9atclduxvf1zxu***</HostName>
<InstanceType>ecs.g5.large</InstanceType>
<CreationTime>2017-12-10T04:04Z</CreationTime>
<Tags>
<Tag>
<TagValue>fqwfew</TagValue>
<TagKey>fefqe</TagKey>
</Tag>
<Tag>
<TagValue>weqfwq</TagValue>
<TagKey>fqewfwqewf</TagKey>
</Tag>
<Tag>
<TagValue>ewqffeqw</TagValue>
<TagKey>fqfwewfqw</TagKey>
</Tag>
</Tags>
<Status>Running</Status>
<ClusterId></ClusterId>
<Recyclable>false</Recyclable>
<RegionId>cn-beijing</RegionId>
<GPUSpec></GPUSpec>
<OperationLocks></OperationLocks>
<GPUAmount>0</GPUAmount>
<InstanceChargeType>PrePaid</InstanceChargeType>
<ExpiredTime>2017-12-17T16:00Z</ExpiredTime>
</Instance>
</Instances>
</DescribeInstancesResponse>
JSON
格式
{
"PageNumber": 1,
"TotalCount": 58,
"PageSize": 1,
"RequestId": "97935DF1-0289-4AA2-9DD1-72377838B16B",
"Instances": {
"Instance": [
{
"ImageId": "centos_7_06_64_20G_alibase_20190711.vhd",
"VlanId": "",
"EipAddress": {
"IpAddress": "",
"AllocationId": "",
"InternetChargeType": ""
},
"ZoneId": "cn-hangzhou-f",
"IoOptimized": true,
"SerialNumber": "51d1353b-22bf-4567-a176-8b3e12e43***",
"Cpu": 2,
"Memory": 8192,
"DeviceAvailable": true,
"SecurityGroupIds": {
"SecurityGroupId": [
"sg-bp17zljqpohu6j2io***"
]
},
"SaleCycle": "",
"AutoReleaseTime": "",
"ResourceGroupId": "",
"OSType": "linux",
"OSName": "CentOS 7.6 64位",
"InstanceNetworkType": "classic",
"HostName": "iZbp1j4i2jdf3owlhebz***",
"CreationTime": "2019-11-11T08:35Z",
"Tags": {
"Tag": [
{
"TagValue": "asg-bp1d8uuut40f4qc40***",
"TagKey": "acs:autoscaling:scalingGroupId"
},
{
"TagValue": "ESS",
"TagKey": "ESS"
}
]
},
"EcsCapacityReservationAttr": {
"CapacityReservationPreference": "none",
"CapacityReservationId": ""
},
"RegionId": "cn-hangzhou",
"DeletionProtection": false,
"OperationLocks": {
"LockReason": []
},
"ExpiredTime": "2099-12-31T15:59Z",
"CpuOptions": {
"Numa": "",
"ThreadsPerCore": 2,
"CoreCount": 1
},
"InnerIpAddress": {
"IpAddress": [
"10.80.61.42"
]
},
"InstanceTypeFamily": "ecs.mn4",
"InstanceId": "i-bp1j4i2jdf3owlheb***",
"InternetMaxBandwidthIn": 500,
"CreditSpecification": "",
"InternetChargeType": "PayByTraffic",
"SpotStrategy": "NoSpot",
"StoppedMode": "Not-applicable",
"InternetMaxBandwidthOut": 1,
"VpcAttributes": {
"NatIpAddress": "",
"PrivateIpAddress": {
"IpAddress": []
},
"VSwitchId": "",
"VpcId": ""
},
"SpotPriceLimit": 0,
"StartTime": "2019-11-11T08:35Z",
"InstanceName": "ECS-asg-MyFirstScalingGroup",
"Description": "ECS",
"OSNameEn": "CentOS 7.6 64 bit",
"PublicIpAddress": {
"IpAddress": [
"121.40.77.XXX"
]
},
"InstanceType": "ecs.mn4.large",
"Status": "Running",
"Recyclable": false,
"ClusterId": "",
"GPUSpec": "",
"InstanceChargeType": "PostPaid",
"GPUAmount": 0,
"DedicatedHostAttribute": {
"DedicatedHostId": "",
"DedicatedHostName": ""
},
"DedicatedInstanceAttribute": {
"Affinity": "",
"Tenancy": ""
},
"DeploymentSetId": ""
}
]
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | InvalidInstanceChargeType.NotFound | The InstanceChargeType does not exist in our records | 指定的实例升降配规格不存在。 |
404 | InvalidInternetChargeType.ValueNotSupported | The specified InternetChargeType is not valid | 指定的网络计费方式不合法。 |
404 | InvalidLockReason.NotFound | The specified LockReason is not found | 指定的锁定类型不存在。 |
404 | InvalidFilterKey.NotFound | 指定的起始时间或到期时间参数错误。 | |
404 | InvalidFilterValue | 您输了的时间格式不合法。 | |
404 | InvalidNetworkType.NotFound | The specified InstanceNetworkType is not found | 指定的带宽类型不存在。 |
404 | InvalidStatus.NotFound | The specified Status is not found | 指定的资源状态不存在。 |
400 | InvalidTag.Mismatch | The specified Tag.n.Key and Tag.n.Value are not match. | 指定的 Tag.n.Key 和 Tag.n.Value 不匹配。 |
400 | InvalidTagCount | The specified tags are beyond the permitted range. | 指定的标记超出取值范围。 |
400 | InvalidHpcClusterId.NotFound | The specified HpcClusterId is not found. | 指定的参数“HpcClusterId”不存在。 |
400 | InvalidHpcClusterId.Creating | The specified HpcClusterId is creating. | 指定的 HPC 集群正在创建中。 |
访问错误中心查看更多错误码。
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论