ListImages - 查询镜像资源

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

调试

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

授权信息

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

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

请求参数

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

地域 ID。

cn-hangzhou
ImageIdarray

镜像 ID,N 的取值范围:1~100

string

镜像 id。

cpm-xxxxxxxx
ImageNamestring

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

testImageName
ImageCategorystring

镜像来源。取值范围:

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

实例规格。

ecp.ce.large
Statusstring

查询某种状态下的镜像。取值范围:

  • Waiting:多任务排队中。
  • Creating:镜像正在创建中。
  • Copying:镜像正在复制中。
  • Importing:镜像正在导入中。
  • Available(默认):您可以使用的镜像。
  • CreateFailed:创建失败的镜像。
Available
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值,初次调用无需配置。

ADBAAdDWBF2****
MaxResultsinteger

返回的最大数,取值范围:1~100。

50

返回参数

名称类型描述示例值
object
NextTokenstring

返回下一页的查询凭证。

ADBAAdDWBF2****
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCountinteger

镜像总数。

3
MaxResultsinteger

返回的最大数,取值范围:1~100。

50
RegionIdstring

地域。

cn-hangzhou
Imagesobject []

镜像列表。

Statusstring

镜像状态。

Available
CreationTimestring

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

2021-01-01T01:07Z
Progressstring

镜像的制作进度。

100%
Usagestring

镜像是否已经运行在云手机实例中。取值范围:

  • none:镜像处于闲置状态,暂无云手机实例使用。
  • instance:镜像处于运行状态,有云手机实例使用。
none
IsSelfSharedboolean

该镜像是否已共享给其他用户。

false
Descriptionstring

镜像描述。

testDescription
ImageNamestring

镜像的名称。

testImageName
OSNameEnstring

操作系统的英文显示名称。

Android 9.0
Platformstring

操作系统发行版。

Android 9.0
ImageCategorystring

镜像类型。

system
OSNamestring

操作系统的中文显示名称。

Android 9.0
ImageIdstring

镜像 ID。

cpm-xxxxxxxx
OSTypestring

操作系统类型。

android

示例

正常返回示例

JSON格式

{
  "NextToken": "ADBAAdDWBF2****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 3,
  "MaxResults": 50,
  "RegionId": "cn-hangzhou",
  "Images": {
    "Image": [
      {
        "Status": "Available",
        "CreationTime": "2021-01-01T01:07Z",
        "Progress": "100%",
        "Usage": "none",
        "IsSelfShared": false,
        "Description": "testDescription",
        "ImageName": "testImageName",
        "OSNameEn": "Android 9.0",
        "Platform": "Android 9.0",
        "ImageCategory": "system",
        "OSName": "Android 9.0",
        "ImageId": "cpm-xxxxxxxx",
        "OSType": "android"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-06-14OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:InstanceType