全部产品
弹性计算 会员服务 网络 安全 移动云 数加·大数据分析及展现 数加·大数据应用 管理与监控 云通信 阿里云办公 培训与认证 更多
存储与CDN 数据库 域名与网站(万网) 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 智能硬件
云服务器 ECS

DescribeInstances

更新时间:2018-04-27 22:29:15

描述

查询一台或多台实例的详细信息。

请求参数的作用类似于一个过滤器,过滤器为逻辑与(AND)关系。如果某一参数为空,则过滤器不起作用。但是参数 InstanceIds 如果是一个空 JSON 数组,即 [],则视为该过滤器有效,且返回空。

请求参数

名称 类型 是否必需 描述
Action String 系统规定参数。取值:DescribeInstances
RegionId String 地域 ID。更多详情,请参阅 地域与可用区,或者调用 DescribeRegions 查看最新的阿里云地域列表。
VpcId String 专有网络 VPC ID。
VSwitchId String 虚拟交换机 ID。
ZoneId String 可用区 ID。
InstanceIds String 实例 ID。取值可以由多个实例 ID 组成一个 JSON 数组,格式为 ["i-xxxxxxxxx", "i-yyyyyyyyy", … "i-zzzzzzzzz"],最多支持 100 个 ID,ID 之间用半角逗号(,)隔开。
InstanceType String 实例的规格。
InstanceTypeFamily String 实例的规格族。
InstanceNetworkType String 实例网络类型。取值范围:
  • classic:经典网络
  • vpc:VPC
PrivateIpAddresses String VPC 网络类型实例的私有 IP。当 InstanceNetworkType=vpc 时生效,取值可以由多个 IP 组成一个 JSON 数组,格式为 ["172.16.1.1", "172.16.2.1", … "172.16.10.1"],最多支持 100 个 IP,IP 之间用半角逗号(,)隔开。
InnerIpAddresses String 经典网络类型实例的内网 IP 列表。当 InstanceNetworkType=classic 时生效,取值可以由多个 IP 组成一个 JSON 数组,格式为 ["10.1.1.1", "10.1.2.1", … "10.1.10.1"],最多支持 100 个 IP,IP 之间用半角逗号(,)隔开。
PublicIpAddresses String 经典网络类型实例的公网 IP 列表。当 InstanceNetworkType=classic 时生效,取值可以由多个 IP 组成一个 JSON 数组,格式为 ["42.1.1.1", "42.1.2.1", … "42.1.10.1"],最多支持 100 个 IP,IP 之间用半角逗号(,)隔开。
SecurityGroupId String 实例所属的安全组。
InstanceChargeType String 实例的计费方式。取值范围:
  • PrePaid:包年包月
  • PostPaid:按量付费
SpotStrategy String 后付费实例的竞价策略。当 InstanceChargeType=PostPaid 时生效,取值范围:
  • 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 实例的标签键。n 的取值范围:[1, 5]。
最多支持 64 个字符。
不能以 aliyun、http:// 或者 https:// 开头。
Tag.n.Value String 实例的标签值。n 的取值范围:[1, 5]。
最多支持 128 个字符。
不能以 aliyun、http:// 或者 https:// 开头。
PageNumber Integer 实例状态列表的页码。
起始值:1
默认值:1
PageSize Integer 分页查询时设置的每页行数。
最大值:100
默认值:10

返回参数

名称 类型 描述
TotalCount Integer 实例总台数
PageNumber Integer 实例列表的页码
PageSize Integer 输入时设置的每页行数
Instances InstanceAttributesType 由 InstanceAttributesType 组成的数组格式,返回实例的信息

示例

请求示例

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

返回示例

XML 格式

  1. <DescribeInstancesResponse>
  2. <PageNumber>1</PageNumber>
  3. <TotalCount>6</TotalCount>
  4. <PageSize>10</PageSize>
  5. <RequestId>8EF01A45-FFFA-497B-B5C3-1DE1B74DB32D</RequestId>
  6. <Instances>
  7. <Instance>
  8. <InnerIpAddress/>
  9. <ImageId>ubuntu_16_0402_64_20G_alibase_20170818.vhd</ImageId>
  10. <InstanceTypeFamily>ecs.g5</InstanceTypeFamily>
  11. <VlanId/>
  12. <NetworkInterfaces>
  13. <NetworkInterface>
  14. <MacAddress>00:16:3e:32:b4:dc</MacAddress>
  15. <PrimaryIpAddress>172.17.XX.XXX</PrimaryIpAddress>
  16. <NetworkInterfaceId>eni-2zeh9atclduxvf1zcyal</NetworkInterfaceId>
  17. </NetworkInterface>
  18. </NetworkInterfaces>
  19. <InstanceId>XXXXXXXXXXX</InstanceId>
  20. <EipAddress>
  21. <IpAddress/>
  22. <AllocationId/>
  23. <InternetChargeType/>
  24. </EipAddress>
  25. <InternetMaxBandwidthIn>1000</InternetMaxBandwidthIn>
  26. <ZoneId>cn-beijing-e</ZoneId>
  27. <InternetChargeType>PayByBandwidth</InternetChargeType>
  28. <SpotStrategy>NoSpot</SpotStrategy>
  29. <StoppedMode>Not-applicable</StoppedMode>
  30. <SerialNumber>d9bd1cdc-624d-4736-9da5-2ba2f741a304</SerialNumber>
  31. <IoOptimized>true</IoOptimized>
  32. <Memory>8192</Memory>
  33. <Cpu>2</Cpu>
  34. <VpcAttributes>
  35. <NatIpAddress/>
  36. <PrivateIpAddress>
  37. <IpAddress>172.17.XX.XXX</IpAddress>
  38. </PrivateIpAddress>
  39. <VSwitchId>vsw-2zeh0r1pabwtg6wcssgca</VSwitchId>
  40. <VpcId>vpc-2zeuphj08tt7q3brdb36x</VpcId>
  41. </VpcAttributes>
  42. <InternetMaxBandwidthOut>1</InternetMaxBandwidthOut>
  43. <DeviceAvailable>true</DeviceAvailable>
  44. <SecurityGroupIds>
  45. <SecurityGroupId>sg-2ze21r9qb638hvtrvsus</SecurityGroupId>
  46. </SecurityGroupIds>
  47. <SpotPriceLimit>0.0</SpotPriceLimit>
  48. <SaleCycle>Week</SaleCycle>
  49. <AutoReleaseTime/>
  50. <InstanceName>ECS-BUY-2017-57-10</InstanceName>
  51. <Description/>
  52. <ResourceGroupId/>
  53. <OSType>linux</OSType>
  54. <OSName>Ubuntu 16.04 64</OSName>
  55. <InstanceNetworkType>vpc</InstanceNetworkType>
  56. <PublicIpAddress>
  57. <IpAddress>47.94.XX.XX</IpAddress>
  58. </PublicIpAddress>
  59. <HostName>iZ2zeh9atclduxvf1zxuylZ</HostName>
  60. <InstanceType>ecs.g5.large</InstanceType>
  61. <CreationTime>2017-12-10T04:04Z</CreationTime>
  62. <Tags>
  63. <Tag>
  64. <TagValue>fqwfew</TagValue>
  65. <TagKey>fefqe</TagKey>
  66. </Tag>
  67. <Tag>
  68. <TagValue>weqfwq</TagValue>
  69. <TagKey>fqewfwqewf</TagKey>
  70. </Tag>
  71. <Tag>
  72. <TagValue>ewqffeqw</TagValue>
  73. <TagKey>fqfwewfqw</TagKey>
  74. </Tag>
  75. </Tags>
  76. <Status>Running</Status>
  77. <ClusterId/>
  78. <Recyclable>false</Recyclable>
  79. <RegionId>cn-beijing</RegionId>
  80. <GPUSpec/>
  81. <OperationLocks/>
  82. <GPUAmount>0</GPUAmount>
  83. <InstanceChargeType>PrePaid</InstanceChargeType>
  84. <ExpiredTime>2017-12-17T16:00Z</ExpiredTime>
  85. </Instance>
  86. </Instances>
  87. </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.XX.XXX"
  14. ]
  15. },
  16. "InstanceChargeType": "PostPaid",
  17. "InstanceId": "XXXXXXXXX",
  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.XX.XXX"
  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. }

错误码

错误代码 错误信息 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.KeyTag.n.Value 必须键值匹配。
InvalidTagCount The specified tags are beyond the permitted range. 400 指定的标签数不能超过五个。
本文导读目录