调用ListImages接口查询镜像资源_弹性云手机(ECP)-阿里云帮助中心

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
cloudphone:ListImages	Read	Image acs:cloudphone:{#regionId}:{#accountId}:image/* Image acs:cloudphone:{#regionId}:{#accountId}:image/{#imageId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
ImageId	array	否	镜像 ID，N 的取值范围：1~100
	string	否	镜像 id。	cpm-xxxxxxxx
ImageName	string	否	镜像名称。长度为 2~128 个英文或中文字符。必须以大小字母或中文开头，不能以`http://`和`https://`开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。	testImageName
ImageCategory	string	否	镜像来源。取值范围： system：阿里云提供的公共镜像。 self：您创建的自定义镜像。 others：其他阿里云用户共享给您的镜像。	system
InstanceType	string	否	实例规格。	ecp.ce.large
Status	string	否	查询某种状态下的镜像。取值范围： Waiting：多任务排队中。 Creating：镜像正在创建中。 Copying：镜像正在复制中。 Importing：镜像正在导入中。 Available（默认）：您可以使用的镜像。 CreateFailed：创建失败的镜像。	Available
NextToken	string	否	查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值，初次调用无需配置。	ADBAAdDWBF2****
MaxResults	integer	否	返回的最大数，取值范围：1~100。	50

返回参数

名称	类型	描述	示例值
	object
NextToken	string	返回下一页的查询凭证。	ADBAAdDWBF2****
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	镜像总数。	3
MaxResults	integer	返回的最大数，取值范围：1~100。	50
RegionId	string	地域。	cn-hangzhou
Images	object []	镜像列表。
Status	string	镜像状态。	Available
CreationTime	string	镜像创建时间，采用 ISO 8601 格式。	2021-01-01T01:07Z
Progress	string	镜像的制作进度。	100%
Usage	string	镜像是否已经运行在云手机实例中。取值范围： none：镜像处于闲置状态，暂无云手机实例使用。 instance：镜像处于运行状态，有云手机实例使用。	none
IsSelfShared	boolean	该镜像是否已共享给其他用户。	false
Description	string	镜像描述。	testDescription
ImageName	string	镜像的名称。	testImageName
OSNameEn	string	操作系统的英文显示名称。	Android 9.0
Platform	string	操作系统发行版。	Android 9.0
ImageCategory	string	镜像类型。	system
OSName	string	操作系统的中文显示名称。	Android 9.0
ImageId	string	镜像 ID。	cpm-xxxxxxxx
OSType	string	操作系统类型。	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"
      }
    ]
  }
}