查询实例列表
描述
查询所有实例的详细信息。
此接口不会校验参数之间的依赖关系，返回结果是所有条件的"交集"。
如果参数为空，则过滤器不起作用，但是 InstanceIds 如果是一个空 Json Array(即[])，则视为该过滤器有效，且返回空。
请求参数
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| Action | String | 是 | 系统规定参数，取值：DescribeInstances |
| RegionId | String | 是 | 地域 |
| VpcId | String | 否 | 专有网络 Id |
| VSwitchId | String | 否 | 交换机 Id |
| ZoneId | String | 否 | 可用区 Id |
| InstanceIds | String | 否 | 实例的编号列表 一个带有格式的 Json Array：[“i-xxxxxxxxx”, ”i-yyyyyyyyy”, … “i-zzzzzzzzz”]，最多 100 个 Id，用半角逗号字符隔开。 |
| InstanceType | String | 否 | 实例的规格 |
| InstanceTypeFamily | String | 否 | 实例的规格族 |
| InstanceNetworkType | String | 否 | 实例网络类型 |
| PrivateIpAddresses | String | 否 | VPC 类型实例的私网 IP 列表. 当 NetworkType 为 VPC 时，这个参数生效. 一个带有格式的 Json Array：[“172.16.1.1”, ”172.16.2.1”, … “172.16.10.1”]，最多 100 个 IP，用半角逗号字符隔开。 |
| InnerIpAddresses | String | 否 | Classic 类型实例的私网 IP 列表. 当 NetworkType 为 Classic 时，这个参数生效. 一个带有格式的 Json Array：[“10.1.1.1”, ”10.1.2.1”, … “10.1.10.1”]，最多 100 个 IP，用半角逗号字符隔开。 |
| PublicIpAddresses | String | 否 | Classic 类型实例的公网 IP 列表. 当 NetworkType 为 Classic 时，这个参数生效. 一个带有格式的 Json Array：[“42.1.1.1”, ”42.1.2.1”, … “42.1.10.1”]，最多 100 个 IP，用半角逗号字符隔开。 |
| SecurityGroupId | String | 否 | 实例所属的安全组 |
| InstanceChargeType | String | 否 | 实例的付费方式。
|
| InternetChargeType | String | 否 | 网络计费类型，PayByBandwidth | PayByTraffic两个值中的一个。预付费实例显示PayByBandwidth（按带宽计费）。
|
| InstanceName | String | 否 | 实例名称 |
| ImageId | String | 否 | 镜像 ID |
| Status | String | 否 | 实例状态，可选值：
|
| DeviceAvailable | String | 否 | 实例是否还可以挂载磁盘。 True | False |
| IoOptimized | String | 否 | 是否是 IO 优化型实例 True | False |
| Tag.n.Key | String | 否 | 标签 key，n 从 1 开始，最大为 5。 不允许为空字符串。 |
| Tag.n.Value | String | 否 | 标签 value，n 从 1 开始，最大为 5。 允许为空字符串。 |
| PageNumber | Integer | 否 | 实例状态列表的页码，起始值为 1，默认值为 1 |
| PageSize | Integer | 否 | 分页查询时设置的每页行数，最大值 100 行，默认为 10 |
返回参数
| 名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 实例总个数 |
| PageNumber | Integer | 实例列表的页码 |
| PageSize | Integer | 输入时设置的每页行数 |
| Instances | InstanceAttributesType | 由 InstanceAttributesType 组成的数组格式，返回实例的信息 |
错误码
| 错误代码 | 描述 | Http状态码 | 语义 |
|---|---|---|---|
| InvalidInstanceChargeType.NotFound | The InstanceChargeType does not exist in our records | 404 | 指定的 InstanceChargeType 不存在 |
| InvalidInternetChargeType.ValueNotSupported | The specified InternetChargeType is not valid. | 404 | 指定的 InternetChargeType 不存在 |
| InvalidNetworkType.NotFound | The specified InstanceNetworkType is not found | 404 | 指定的 InstanceNetworkType 不存在 |
| InvalidStatus.NotFound | The specified Status is not found | 404 | 指定的 Status 不存在 |
示例
请求示例
https://ecs.aliyuncs.com/?Action=DescribeInstances
&RegionId=cn-hangzhou
&<公共请求参数>
返回示例
XML格式
2014-09-21T01:12:35Z
true
2011-09-08T16:00Z
iZ25skktcp4Z
ubuntu1404_64_20G_aliaegis_20140703.vhd
PostPaid
i-25skktcp4
iZ25skktcp4Z
vpc
ecs.t1.xsmall
-1
false
cn-beijing
sg-25am0n4q0
51d1353b-22bf-4567-a176-8b3e12e43135
Running
10.175.68.212
192.168.2.3
vsw-25gbsqby3
vpc-25onv3oi4
cn-beijing-a
JSON格式
{
"Instances": {
"Instance": [
{
"CreationTime": "2015-07-27T07:08Z",
"DeviceAvailable": true,
"EipAddress": {},
"ExpiredTime": "2011-09-08T16:00Z",
"HostName": "iZ94t3s0jxkZ",
"ImageId": "centos6u5_64_20G_aliaegis_20150130.vhd",
"InnerIpAddress": {
"IpAddress": [
"10.170.106.80"
]
},
"InstanceChargeType": "PostPaid",
"InstanceId": "i-94t3s0jxk",
"InstanceName": "ddu6027u80fdu6d4bu8bd5",
"InstanceNetworkType": "classic",
"InstanceType": "ecs.s2.large",
"InternetChargeType": "PayByTraffic",
"InternetMaxBandwidthIn": -1,
"InternetMaxBandwidthOut": 1,
"IoOptimized": false,
"OperationLocks": {
"LockReason": []
},
"PublicIpAddress": {
"IpAddress": [
"120.25.13.106"
]
},
"RegionId": "cn-shenzhen",
"SecurityGroupIds": {
"SecurityGroupId": [
"sg-94kd0cyg0"
]
},
"SerialNumber": "51d1353b-22bf-4567-a176-8b3e12e43135",
"Status": "Running",
"VpcAttributes": {
"PrivateIpAddress": {
"IpAddress": []
}
},
"ZoneId": "cn-shenzhen-a"
}
]
},
"PageNumber": 1,
"PageSize": 10,
"RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
"TotalCount": 1
}