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

DescribeImages

更新时间:2018-04-28 09:28:39

描述

查询您可以使用的镜像资源。调用该接口时,您需要注意:

  • 您可以查询的镜像资源包括您的自定义镜像,阿里云提供的公共镜像,云市场的镜像,以及其他阿里云用户主动共享给您的共享镜像。

  • 该接口支持分页查询,查询结果包括可使用的镜像资源的总数和当前页的镜像资源。每页的数量默认为 10 条。

请求参数

名称 类型 是否必需 描述
Action String 系统规定参数。取值:DescribeImages
RegionId String 实例所属的地域 ID。更多详情,请参阅 地域与可用区,或者调用 DescribeRegions 查看最新的阿里云地域列表。
ImageId String 镜像 ID。单次最多查询 100 条 ID,ID 之间用半角逗号字符 , 隔开。
Status String 查询某种状态下的镜像。取值范围:
  • Creating:镜像正在创建中。
  • Available:您可以使用的镜像。
  • UnAvailable:您不能使用的镜像。
  • CreateFailed:创建失败的镜像。
默认值:Available
支持同时取多个值,值之间以半角逗号 , 隔开。
SnapshotId String 根据某一快照 ID 创建的自定义镜像。
ImageName String 镜像名称。
ImageOwnerAlias string 镜像来源。取值范围:
  • system:阿里云提供的公共镜像。
  • self:您创建的自定义镜像。
  • others:其他阿里云用户共享给您的镜像。
  • marketplace:镜像市场 提供的镜像。 您查询到的云市场镜像可以直接使用,无需提前订阅。您需要自行留意云市场镜像的收费详情。
默认值:空,空表示返回取值为 systemself 以及 others 的结果。
Usage String 镜像是否已经运行在 ECS 实例中。取值范围:
  • instance:镜像处于运行状态,有 ECS 实例使用。
  • none:镜像处于闲置状态,暂无 ECS 实例使用。
Tag.n.Key String 标签键。n 的取值范围:[1, 5]
若您根据标签查询镜像资源,标签键不允许为空字符串。
Tag.n.Value String 标签值。n 的取值范围:[1, 5]
若您根据标签查询镜像资源,标签值允许为空字符串。
PageNumber Integer 镜像资源列表的页码。起始值:1
默认值:1
PageSize Integer 分页查询时设置的每页行数。最大值:50
默认值:10

返回参数

名称 类型 描述
RegionId String 镜像所属地域 ID
TotalCount Integer 镜像资源总数
PageNumber Integer 当前页码
PageSize Integer 当前分页包含多少条目
Images Array 镜像信息 ImageType 组成的集合。

示例

请求示例

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

返回示例

XML 格式

  1. <DescribeImagesResponse>
  2. <Images>
  3. <Image>
  4. <Architecture>i386</Architecture>
  5. <CreationTime>2014-07-22T09:53:44Z</CreationTime>
  6. <Description></Description>
  7. <DiskDeviceMappings>
  8. <DiskDeviceMapping>
  9. <Device>/dev/xvda</Device>
  10. <Size>20</Size>
  11. <SnapshotId></SnapshotId>
  12. </DiskDeviceMapping>
  13. </DiskDeviceMappings>
  14. <ImageId>suse11sp3_64_20G_aliaegis_20150428.vhd</ImageId>
  15. <ImageName>suse11sp3_64_20G_aliaegis_20150428.vhd</ImageName>
  16. <ImageOwnerAlias>system</ImageOwnerAlias>
  17. <ImageVersion>1.0</ImageVersion>
  18. <IsCopied>false</IsCopied>
  19. <IsSubscribed>false</IsSubscribed>
  20. <OSName>SUSE Linux Enterprise Server 11 SP3 64位</OSName>
  21. <ProductCode></ProductCode>
  22. <OSType>linux</OSType>
  23. <Platform>SUSE</Platform>
  24. <Progress>100</Progress>
  25. <Size>20</Size>
  26. <Status>Available</Status>
  27. <Usage>instance</Usage>
  28. </Image>
  29. </Images>
  30. <PageNumber>1</PageNumber>
  31. <PageSize>2</PageSize>
  32. <RegionId>cn-hangzhou</RegionId>
  33. <TotalCount>24</TotalCount>
  34. <RequestId>7871BB26-3002-4950-B2E6-98D333077EA5</RequestId>
  35. </DescribeImagesResponse>

JSON 格式

  1. {
  2. "Images": {
  3. "Image": [
  4. {
  5. "Architecture": "x86_64",
  6. "CreationTime": "2015-05-06T09:01:32Z",
  7. "DiskDeviceMappings": {
  8. "DiskDeviceMapping": [
  9. {
  10. "Device": "/dev/xvda",
  11. "Size": "20"
  12. }
  13. ]
  14. },
  15. "ImageId": "suse11sp3_64_20G_aliaegis_20150428.vhd",
  16. "ImageName": "suse11sp3_64_20G_aliaegis_20150428.vhd",
  17. "ImageOwnerAlias": "system",
  18. "ImageVersion": "1",
  19. "IsCopied": false,
  20. "IsSubscribed": false,
  21. "OSName": "SUSE Linux Enterprise Server 11 SP3 64位",
  22. "OSType": "linux",
  23. "Platform": "SUSE",
  24. "Progress": "100%",
  25. "Size": 20,
  26. "Status": "Available",
  27. "Usage": "instance"
  28. }
  29. ]
  30. }
  31. "PageNumber": 1,
  32. "PageSize": 1,
  33. "RegionId": "cn-hangzhou",
  34. "RequestId": "49CBCED4-C9B9-4851-BEB5-8FB5E5169E30",
  35. "TotalCount": 24
  36. }

错误码

错误代码 错误信息 HTTP 状态码 说明
InvalidImageOwnerAlias.ValueNotSupported The specified ImageOwnerAlias value is not supported. 400 参数 ImageOwnerAlias 取值不合法。
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 指定的标签数不能超过五个。
InvalidUsage The specifed Usage is not valid 404 指定的 Usage 不合法。
本文导读目录