ListImage - 查询镜像信息

更新时间:
复制 MD 格式

查询镜像信息。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

appstreaming:ListImage

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

ImageId

string

镜像 ID。

img-bp13mu****

ImageName

string

镜像名称,支持模糊搜索。

DemoImage

Status

string

镜像状态,用户查询对应状态的镜像,默认是查询所有未删除状态的镜像。

枚举值:

  • AVAILABLE :

    可用

  • INIT :

    初始化中

  • CREATE_FAILED :

    创建失败

  • CREATING :

    创建中

INIT

ImageType

string

镜像类型。

枚举值:

  • User :

    自定义镜像

  • Shared :

    共享镜像

  • System :

    系统镜像

  • Community :

    社区镜像

User

PackageType

string

镜像封装类型。

枚举值:

  • Ecs_Container :

    ECS+Docker 镜像

  • Ecs :

    Ecs 镜像

Ecs

OsType

string

镜像操作系统类型。

枚举值:

  • Linux :

    Linux

  • Unknown :

    未知

  • Windows :

    Windows

  • Android :

    Android

Windows

BizType

integer

业务类型。暂不对外透出使用。

枚举值:

  • 1 :

    [默认值]

1

ProductType

string

产品类型。

枚举值:

  • CloudDesktop :

    无影云电脑

  • CloudApp :

    无影云应用

  • WuyingServer :

    无影工作站

CloudApp

ProtocolType

string

镜像协议类型。

枚举值:

  • HDX :

    HDX 协议

  • ASP :

    阿里云自研 ASP 协议

ASP

PageSize

integer

分页查询时每页的行数。最大值:100。默认值:10。

10

PageNumber

integer

当前页码。

1

ProductTypeList

array

当镜像支持多个产品时可以支持的产品列表。

string

产品类型。

枚举值:

  • CloudDesktop :

    无影云电脑

  • CloudApp :

    无影云应用

  • WuyingServer :

    无影工作站

CloudApp

BizTypeList

array

所有业务类型列表,暂不对外透出使用。

integer

业务类型。根据您使用的业务填写使用。

枚举值:

  • 1 :

    [默认值]

1

FeatureList

array

镜像支持的特征列表。

string

镜像支持的特征。

枚举值:

  • FotaChannel :

    支持的 fota 渠道

  • Builder :

    支持镜像 Builder

  • MultiSession :

    支持多 Session

  • GPU :

    支持 GPU

GPU

LanguageType

string

语言。

枚举值:

  • en-US :

    英语

  • zh-HK :

    繁体中文(香港)

  • zh-CN :

    简体中文

  • ja-JP :

    日语

zh-CN

ResourceInstanceType

string

查找某些固定规格的镜像。

eds.enterprise_office.2c4g

FotaVersion

string

镜像版本信息。

2.0.3-xxxx

PlatformName

string

操作系统平台名称。

枚举值:

  • Ubuntu :

    Ubuntu 操作系统

  • Debian :

    Debian 操作系统

  • Windows Server 2022 :

    Windows Server 2022 操作系统

  • Windows Server 2019 :

    Windows Server 2019 操作系统

  • Windows Server 2016 :

    Windows Server 2016 操作系统

  • Windows 11 :

    Windows 11 操作系统

  • Windows 10 :

    Windows 10 操作系统

Windows Server 2019

BizRegionIdList

array

支持地域列表。 无影镜像是中心化的,通过这个查询该镜像部署的地域。

string

地域 ID。

cn-shanghai

TagList

array<object>

标签查询。

object

Key

string

用户自定义的标签 Key。

env

Value

string

用户自定义的标签 Value。

test

PlatformNameList

array

支持的平台类型列表,枚举值参考上面的 PlatformName。

string

镜像平台名称。

Windows 11

Distro

string

返回参数

名称

类型

描述

示例值

object

镜像信息结构体。

PageSize

integer

每页展示数据条数。

10

PageNumber

integer

返回数据的页数。

1

Data

array<object>

返回数据对象。

array<object>

返回对象。

GmtCreate

string

创建时间。

2025-04-25 15:13:57

GmtModified

string

更新时间。

2025-04-25 15:13:57

AliUid

integer

租户 ID。

123456789

ImageId

string

系统镜像 ID 有含义,自定义镜像自动生成。

imgc-xxxx

ImageName

string

镜像名称。

DemoImage

ImageType

string

镜像类型。

User

PackageType

string

镜像封装类型。

ECS

Description

string

镜像描述。

描述

OsType

string

镜像类型。

Windows

ProtocolType

string

协议类型。

ASP

BizType

integer

业务类型。

1

ProductType

string

产品类型。

CloudApp

VersionId

string

镜像版本。

iv-xxx

OnlineVersionId

string

当前镜像标记从该子版本读取主镜像信息。(一个镜像是由多个子版本组成)

iv-xxxx

LatestVersionId

string

该镜像的最新子版本。(一个镜像是由多个子版本组成)

iv-xxx

Status

string

镜像状态。

INIT

ParentImageId

string

父镜像 ID,只表示继承关系,系统镜像无父镜像。

imgc-xxx

ParentImageVersion

string

父镜像版本。

iv-xxx

BaseImageId

string

基础镜像 ID。

imgc-xxx

BaseImageVersion

string

基础镜像版本。

iv-xxx

FotaVersion

string

FOTA 版本。

2.3.0-xxx

Language

string

镜像语言。如果封装类型为 VHD/Container 时,继承于该镜像组合的封装类型为 ECS 的镜像属性。

zh-CN

Platform

integer

镜像操作系统平台。

说明

如果封装类型为 VHD/Container,继承于该镜像组合的封装类型为 ECS 的镜像属性。

Windows

OnlineVersion

boolean

当前版本是否是生效版本。

true

SystemDiskSize

integer

系统盘大小。单位:GiB。

说明

系统盘大小不能小于镜像文件。

40

DataDiskSize

integer

数据盘大小。单位:GiB。

100

AppList

array<object>

应用配置。

object

AppId

string

应用 ID。

ca-xxx

AppName

string

应用名称。

应用名称

FeatureList

array

镜像特征标记列表。

string

镜像特征标记。

Builder

ImageCreateMode

string

镜像创建类型

枚举值:

  • BY_SNAPSHOT_ID :

    从快照创建或者只包含系统盘时

  • BUILDER_MANUAL :

    手动生成镜像

  • INSTANCE_AUTO :

    基于实例自动化生成镜像

  • BY_INSTANCE_ID :

    从实例创建或者包含系统盘和数据盘时

BUILDER_MANUAL

ImageRegionList

array

地域。

string

地域对象。

地域对象。

Distro

string

发行版名字。

Ubuntu 22.04 64

VersionName

string

版本名称。

v0.1.0

ResourceInstanceCategory

string

镜像支持资源类型。

["eds.cpu.category"]

PlatformName

string

系统平台名称。

Windows Server 2022

SupportedLanguageList

array

支持语言列表。

string

支持语言。

zh-CN

VolumeEncryptionEnabled

boolean

是否开启磁盘加密。

true

VolumeEncryptionKey

string

开启磁盘加密的情况下使用的 KMS 的密钥 ID。

a7b3c0c8-xxxx

SessionType

string

会话类型。

枚举值:

  • SINGLE_SESSION :

    单会话

  • MULTIPLE_SESSION :

    多会话

SINGLE_SESSION

ImageRegionDistributeList

array<object>

叠层有效地域信息。

object

ImageId

string

系统镜像 ID 有含义,自定义镜像自动生成。

imgc-xxx

RegionId

string

支持地域。

cn-shanghai

Status

string

状态。

INIT

VersionId

string

镜像版本。

iv-xxx

Progress

string

进度百分比。

70%

FotaChannel

string

说明

此参数暂未对外开放使用。

镜像支持的fota渠道,暂未启用

CompatibleMode

boolean

是否为兼容模式。

true

DriverList

array

驱动信息列表。

string

驱动列表。

["00be80de-xxxx-xxxx-xxxx-xxxxxxxxxxxx"]

Scene

string

AIGC

Rating

integer

95

ImageIconUrl

string

EnvironmentId

string

env-164c321f405ca84143e4b730dbe4

TagList

array<object>

object

Key

string

1630348213973321

Value

string

inner

SnapshotList

array<object>

object

SnapshotId

string

VersionId

string

DiskType

string

DiskSubType

string

BindType

string

DiskCategory

string

Size

integer

Count

integer

总条数。

22

Success

boolean

是否调用成功。

枚举值:

  • true :

    调用成功

  • false :

    调用失败

true

Code

string

错误码。

200

Message

string

接口请求返回的信息。

success

RequestId

string

请求 ID。

8737D130-BFD0-5D51-96F6-C08EB1139A25

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "PageNumber": 1,
  "Data": [
    {
      "GmtCreate": "2025-04-25 15:13:57",
      "GmtModified": "2025-04-25 15:13:57",
      "AliUid": 123456789,
      "ImageId": "imgc-xxxx",
      "ImageName": "DemoImage",
      "ImageType": "User",
      "PackageType": "ECS",
      "Description": "描述",
      "OsType": "Windows",
      "ProtocolType": "ASP",
      "BizType": 1,
      "ProductType": "CloudApp",
      "VersionId": "iv-xxx",
      "OnlineVersionId": "iv-xxxx",
      "LatestVersionId": "iv-xxx",
      "Status": "INIT",
      "ParentImageId": "imgc-xxx",
      "ParentImageVersion": "iv-xxx",
      "BaseImageId": "imgc-xxx",
      "BaseImageVersion": "iv-xxx",
      "FotaVersion": "2.3.0-xxx",
      "Language": "zh-CN",
      "Platform": 0,
      "OnlineVersion": true,
      "SystemDiskSize": 40,
      "DataDiskSize": 100,
      "AppList": [
        {
          "AppId": "ca-xxx",
          "AppName": "应用名称"
        }
      ],
      "FeatureList": [
        "Builder"
      ],
      "ImageCreateMode": "BUILDER_MANUAL",
      "ImageRegionList": [
        "地域对象。"
      ],
      "Distro": "Ubuntu 22.04 64位",
      "VersionName": "v0.1.0",
      "ResourceInstanceCategory": "[\"eds.cpu.category\"]",
      "PlatformName": "Windows Server 2022",
      "SupportedLanguageList": [
        "zh-CN"
      ],
      "VolumeEncryptionEnabled": true,
      "VolumeEncryptionKey": "a7b3c0c8-xxxx",
      "SessionType": "SINGLE_SESSION",
      "ImageRegionDistributeList": [
        {
          "ImageId": "imgc-xxx",
          "RegionId": "cn-shanghai",
          "Status": "INIT",
          "VersionId": "iv-xxx",
          "Progress": "70%"
        }
      ],
      "FotaChannel": "镜像支持的fota渠道,暂未启用",
      "CompatibleMode": true,
      "DriverList": [
        "[\"00be80de-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"]"
      ],
      "Scene": "AIGC",
      "Rating": 95,
      "ImageIconUrl": "",
      "EnvironmentId": "env-164c321f405ca84143e4b730dbe4",
      "TagList": [
        {
          "Key": "1630348213973321",
          "Value": "inner"
        }
      ],
      "SnapshotList": [
        {
          "SnapshotId": "",
          "VersionId": "",
          "DiskType": "",
          "DiskSubType": "",
          "BindType": "",
          "DiskCategory": "",
          "Size": 0
        }
      ]
    }
  ],
  "Count": 22,
  "Success": true,
  "Code": "200",
  "Message": "success",
  "RequestId": "8737D130-BFD0-5D51-96F6-C08EB1139A25"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InternalError Internal error. 内部错误
400 InvalidBizType The bizType parameter is invalid. 业务类型不合法。
403 Forbidden.NoPermission You are not authorized to access this page. 您没有权限访问当前页面。

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

变更历史

更多信息,参考变更详情