全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网
云服务器 ECS

DescribeInstances

更新时间:2017-09-12 17:14:00

描述

查询所有实例的详细信息。

  • 此接口不会校验参数之间的依赖关系,而是作为 Filter 进行使用,为逻辑与(AND)关系。
  • 如果参数为空,则过滤器不起作用,但是 InstanceIds 如果是一个空 Json Array(即 []),则视为该过滤器有效,且返回空。

请求参数

名称 类型 是否必须 描述
Action String 系统规定参数。取值:DescribeInstances
RegionId String 地域 ID。
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 经典网络类型实例的内网 IP 列表。当 NetworkType 为 Classic 时,这个参数生效。
参数为一个带有格式的 Json Array:[“10.1.1.1”, ”10.1.2.1”, … “10.1.10.1”],最多 100 个 IP,用半角逗号字符隔开。
PublicIpAddresses String 经典网络类型实例的公网 IP 列表。当 NetworkType 为 Classic 时,这个参数生效。
参数为一个带有格式的 Json Array:[“42.1.1.1”, ”42.1.2.1”, … “42.1.10.1”],最多 100 个 IP,用半角逗号字符隔开。
SecurityGroupId String 实例所属的安全组。
InstanceChargeType String 实例的付费方式。取值范围:
  • PrePaid:预付费,即包年包月
  • PostPaid:后付费,即按量付费
SpotStrategy String 后付费实例的竞价策略
当InstanceChargeType为PostPay时为生效,
可选取值为:
NoSpot,正常按量付费实例;
SpotWithPriceLimit,设置上限价格的竞价实例;
SpotAsPriceGo 系统自动出价,最高按量付费价格。
默认值为NoSpot
InternetChargeType String 网络计费类型。取值范围:
  • PayByTraffic:按流量计费
  • PayByBandwidth:按带宽计费
InstanceName String 实例名称。
ImageId String 镜像 ID。
DeploymentSetId String 部署集 ID。
Status String 实例状态。取值范围:
  • Running
  • Starting
  • Stopping
  • Stopped
IoOptimized String 是否是 I/O 优化型实例。取值范围:
  • True:是 I/O 优化型实例
  • False:不是 I/O 优化型实例
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 不存在。
InvalidTag.Mismatch The specified Tag.n.Key and Tag.n.Value are not match. 400 指定的 Tag.n.Key 和 Tag.n.Value 不匹配。
InvalidTagCount The specified tags are beyond the permitted range. 400 指定的 Tag 数超过了 5 个。

示例

请求示例

  1. https://ecs.aliyuncs.com/?Action=DescribeInstances
  2. &RegionId=cn-hangzhou
  3. &<公共请求参数>

返回示例

XML格式

  1. <DescribeInstancesResponse>
  2. <CreationTime>2014-09-21T01:12:35Z</CreationTime>
  3. <DeviceAvailable>true</DeviceAvailable>
  4. <Description></Description>
  5. <EipAddress>
  6. <AllocationId></AllocationId>
  7. <InternetChargeType></InternetChargeType>
  8. <IpAddress></IpAddress>
  9. </EipAddress>
  10. <ExpiredTime>2011-09-08T16:00Z</ExpiredTime>
  11. <HostName>iZ25skktcp4Z</HostName>
  12. <ImageId>ubuntu1404_64_20G_aliaegis_20140703.vhd</ImageId>
  13. <InnerIpAddress></InnerIpAddress>
  14. <InstanceChargeType>PostPaid</InstanceChargeType>
  15. <IpAddress></IpAddress>
  16. <InstanceId>i-25skktcp4</InstanceId>
  17. <InstanceName>iZ25skktcp4Z</InstanceName>
  18. <InstanceNetworkType>vpc</InstanceNetworkType>
  19. <InstanceType>ecs.t1.xsmall</InstanceType>
  20. <InternetChargeType></InternetChargeType>
  21. <InternetMaxBandwidthIn>-1</InternetMaxBandwidthIn>
  22. <InternetMaxBandwidthOut></InternetMaxBandwidthOut>
  23. <IoOptimized>false</IoOptimized>
  24. <OperationLocks>
  25. <LockReason></LockReason>
  26. </OperationLocks>
  27. <PublicIpAddress>
  28. <IpAddress></IpAddress>
  29. </PublicIpAddress>
  30. <RegionId>cn-beijing</RegionId>
  31. <SecurityGroupIds>
  32. <SecurityGroupId>sg-25am0n4q0</SecurityGroupId>
  33. </SecurityGroupIds>
  34. <SerialNumber>51d1353b-22bf-4567-a176-8b3e12e43135</SerialNumber>
  35. <Status>Running</Status>
  36. <VlanId></VlanId>
  37. <VpcAttributes>
  38. <NatIpAddress>10.175.68.212</NatIpAddress>
  39. <PrivateIpAddress>
  40. <IpAddress>192.168.2.3</IpAddress>
  41. </PrivateIpAddress>
  42. <VSwitchId>vsw-25gbsqby3</VSwitchId>
  43. <VpcId>vpc-25onv3oi4</VpcId>
  44. </VpcAttributes>
  45. <ZoneId>cn-beijing-a</ZoneId>
  46. </DescribeInstancesResponse>

JSON格式

  1. {
  2. "Instances": {
  3. "Instance": [
  4. {
  5. "CreationTime": "2015-07-27T07:08Z",
  6. "DeviceAvailable": true,
  7. "EipAddress": {},
  8. "ExpiredTime": "2011-09-08T16:00Z",
  9. "HostName": "iZ94t3s0jxkZ",
  10. "ImageId": "centos6u5_64_20G_aliaegis_20150130.vhd",
  11. "InnerIpAddress": {
  12. "IpAddress": [
  13. "10.170.106.80"
  14. ]
  15. },
  16. "InstanceChargeType": "PostPaid",
  17. "InstanceId": "i-94t3s0jxk",
  18. "InstanceName": "dd\u6027\u80fd\u6d4b\u8bd5",
  19. "InstanceNetworkType": "classic",
  20. "InstanceType": "ecs.s2.large",
  21. "InternetChargeType": "PayByTraffic",
  22. "InternetMaxBandwidthIn": -1,
  23. "InternetMaxBandwidthOut": 1,
  24. "IoOptimized": false,
  25. "OperationLocks": {
  26. "LockReason": []
  27. },
  28. "PublicIpAddress": {
  29. "IpAddress": [
  30. "120.25.13.106"
  31. ]
  32. },
  33. "RegionId": "cn-shenzhen",
  34. "SecurityGroupIds": {
  35. "SecurityGroupId": [
  36. "sg-94kd0cyg0"
  37. ]
  38. },
  39. "SerialNumber": "51d1353b-22bf-4567-a176-8b3e12e43135",
  40. "Status": "Running",
  41. "VpcAttributes": {
  42. "PrivateIpAddress": {
  43. "IpAddress": []
  44. }
  45. },
  46. "ZoneId": "cn-shenzhen-a"
  47. }
  48. ]
  49. },
  50. "PageNumber": 1,
  51. "PageSize": 10,
  52. "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  53. "TotalCount": 1
  54. }
本文导读目录