文档

DescribeImages - 查询自定义镜像

更新时间:

调用DescribeImages查询您可以使用的镜像资源。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ens:DescribeImagesRead
  • acs:ens::{#accountId}:*

请求参数

名称类型必填描述示例值
EnsRegionIdstring

ENS 节点 ID。

cn-dalian-unicom
ImageIdstring

镜像 ID,仅支持传单个 ID。

支持自定义镜像和公共镜像。

m-5qm2r6xo7njrpdkx04q1o****
Statusstring

此参数暂不使用。

此参数暂不使用。
ImageNamestring

自定义镜像的名称。长度为 2~128 个字符。必须以大小字母或中文开头,不能以aliyunacs:开头,不能包含http://或者https://。可以包含数字、半角句号(.)、半角冒号(:)、下划线(_)或者短划线(-)。

默认值:空,表示保持原有名称不变。

centos_6_08_64_20G_a****
PageNumberstring

查询列表的页码。起始值为 1

默认值:1

1
PageSizestring

分页查询时设置的每页行数,最大值为 50 行。

默认值:10

50
SnapshotIdstring

快照 ID。

mock-clone_snapshot_id

返回参数

名称类型描述示例值
object
Codeinteger

业务返回码,正常返回 0。

0
Imagesobject []

镜像信息集合。

Architecturestring

镜像系统架构类型。可能值:x86_64

x86_64
CreationTimestring

镜像创建时间,采用 ISO 8601 格式。

2017-12-08T12:10:03Z
ImageIdstring

镜像 ID。

centos_6_08_64_20G_alibase_2017****
ImageNamestring

镜像名称。

Ubuntu_16.04
ImageOwnerAliasstring

镜像来源。可能值:

  • system:阿里云提供的公共镜像。
  • self:您创建的自定义镜像。
  • others:其他阿里云用户提供的共享镜像或社区镜像。
system
ImageSizestring

镜像大小,单位:GiB。

40
Platformstring

镜像所使用的操作系统类型。可能值:

  • Linux:Linux 系统。

  • Windows:Windows 系统。

centos
SnapshotIdstring

快照 ID。

mock-clone_snapshot_id
PageNumberinteger

当前页码。

1
PageSizeinteger

当前查询每页的行数。

10
RequestIdstring

请求 ID。

8331AA01-C16D-5481-BB47-D19CEBAA811E
TotalCountinteger

镜像总数。

4

示例

正常返回示例

JSON格式

{
  "Code": 0,
  "Images": {
    "Image": [
      {
        "Architecture": "x86_64",
        "CreationTime": "2017-12-08T12:10:03Z",
        "ImageId": "centos_6_08_64_20G_alibase_2017****",
        "ImageName": "Ubuntu_16.04",
        "ImageOwnerAlias": "system",
        "ImageSize": "40",
        "Platform": "centos",
        "SnapshotId": "mock-clone_snapshot_id"
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "8331AA01-C16D-5481-BB47-D19CEBAA811E",
  "TotalCount": 4
}

错误码

HTTP status code错误码错误信息描述
400MissingParameterThe input parameters that is mandatory for processing this request is not supplied.-
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-01-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2023-03-02OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:SnapshotId
    删除入参:product
    删除入参:Version
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈