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

DescribeImages

更新时间:2017-09-13 12:58:07

描述

查询用户可以使用的镜像列表。显示出的镜像资源列表包括用户自定义的镜像,阿里云提供的公共镜像,第三方镜像市场的镜像和其他用户主动共享给您的共享镜像。镜像市场的镜像需要先到镜像市场的网站上订阅后才能进行创建ECS实例。此接口支持分页查询,查询结果包括可使用的镜像资源的总数和当前页的镜像资源。每页的数量默认为10条。

请求参数

名称 类型 是否必须 描述
Action String 系统规定参数,取值:DescribeImages。
RegionId String 实例所属于的 Region ID。
ImageId String 镜像 ID,最多 100 个 ID,用半角逗号字符隔开。
Status String 镜像状态。
取值:
  • Creating 创建中
  • Available 可用(默认值)
  • UnAvailable 不可用
  • CreateFailed 创建失败
可以取多个值,值之间以半角逗号隔开。
SnapshotId String 创建镜像的快照 ID。
ImageName String 镜像的名称。
ImageOwnerAlias string 镜像所有者别名。
取值:
  • system | self | others | marketplace
默认值:无,表示返回 system + self + others
不设置该参数说明不使用该参数进行过滤条件。
取值说明:
  • system 阿里云官方提供镜像
  • self 用户自定义镜像
  • others 非自己的可用镜像
  • marketplace 镜像市场提供的镜像
Usage String 有引用关系的资源类型,instance | none。
Tag.n.Key String 标签 key,n 从 1 开始,最大为 5。
不允许为空字符串。
Tag.n.Value String 标签 value,n 从 1 开始,最大为 5。
允许为空字符串。
PageNumber Integer 实例状态列表的页码,起始值为 1,默认值为 1。
PageSize Integer 分页查询时设置的每页行数,最大值 50 行,默认值为 10。

返回参数

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

错误码

错误代码 描述 Http状态码 语义
InvalidImageOwnerAlias.ValueNotSupported The specified ImageOwnerAlias value is not supported. 400 无效的 ImageOwnerAlias 取值。
InvalidUsage The specifed Usage is not valid 404 指定的 Usage 不合法。
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 个。
InvalidInstanceType.ValueNotSupported The specified InstanceType beyond the permitted range. 400 指定的InstanceType不合法(超出可选范围)。
InvalidOSType The specifed OSType is not valid 404 指定的 OSType 不合法。
InvalidArchitecture The specifed Architecture is not valid 404 指定的平台架构不合法。

示例

请求示例

  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. }
本文导读目录