ListImage - 查询镜像信息

查询镜像信息。

调试

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

授权信息

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

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

请求参数

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

镜像 ID。

img-bp13mu****
ImageNamestring

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

DemoImage
Statusstring

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

枚举值:
  • AVAILABLE可用
  • INIT初始化中
  • CREATE_FAILED创建失败
  • CREATING创建中
INIT
ImageTypestring

镜像类型。

枚举值:
  • User自定义镜像
  • Shared共享镜像
  • System系统镜像
  • Community社区镜像
User
PackageTypestring

镜像封装类型。

枚举值:
  • Ecs_ContainerECS+Docker镜像
  • EcsEcs镜像
Ecs
OsTypestring

镜像操作系统类型。

枚举值:
  • LinuxLinux
  • Unknown未知
  • WindowsWindows
  • AndroidAndroid
Windows
BizTypeinteger

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

枚举值:
  • 1[默认值]
1
ProductTypestring

产品类型。

枚举值:
  • CloudDesktop无影云电脑
  • CloudApp无影云应用
  • WuyingServer无影工作站
CloudApp
ProtocolTypestring

镜像协议类型。

枚举值:
  • HDXHDX协议
  • ASP阿里云自研ASP协议
ASP
PageSizeinteger

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

10
PageNumberinteger

当前页码。

1
ProductTypeListarray

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

string

产品类型。

枚举值:
  • CloudDesktop无影云电脑
  • CloudApp无影云应用
  • WuyingServer无影工作站
CloudApp
BizTypeListarray

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

integer

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

枚举值:
  • 1[默认值]
1
FeatureListarray

镜像支持的特征列表。

string

镜像支持的特征。

枚举值:
  • FotaChannel支持的fota渠道
  • Builder支持镜像Builder
  • MultiSession支持多Session
  • GPU支持GPU
GPU
LanguageTypestring

语言。

枚举值:
  • en-US英语
  • zh-HK繁体中文(香港)
  • zh-CN简体中文
  • ja-JP日语
zh-CN
ResourceInstanceTypestring

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

eds.enterprise_office.2c4g
FotaVersionstring

镜像版本信息。

2.0.3-xxxx
PlatformNamestring

操作系统平台名称。

枚举值:
  • UbuntuUbuntu操作系统
  • DebianDebian操作系统
  • Windows Server 2022Windows Server 2022操作系统
  • Windows Server 2019Windows Server 2019操作系统
  • Windows Server 2016Windows Server 2016操作系统
  • Windows 11Windows 11操作系统
  • Windows 10Windows 10操作系统
Windows Server 2019
BizRegionIdListarray

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

string

地域 ID。

cn-shanghai
TagListarray<object>

标签查询。

object
Keystring

用户自定义的标签 Key。

env
Valuestring

用户自定义的标签 Value。

test
PlatformNameListarray

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

string

镜像平台名称。

Windows 11

返回参数

名称类型描述示例值
object

镜像信息结构体。

PageSizeinteger

每页展示数据条数。

10
PageNumberinteger

返回数据的页数。

1
Dataarray<object>

返回数据对象。

ImageBaseInfoModelobject

返回对象。

GmtCreatestring

创建时间。

2025-04-25 15:13:57
GmtModifiedstring

更新时间。

2025-04-25 15:13:57
AliUidlong

租户 ID。

123456789
ImageIdstring

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

imgc-xxxx
ImageNamestring

镜像名称。

DemoImage
ImageTypestring

镜像类型。

User
PackageTypestring

镜像封装类型。

ECS
Descriptionstring

镜像描述。

描述
OsTypestring

镜像类型。

Windows
ProtocolTypestring

协议类型。

ASP
BizTypeinteger

业务类型。

1
ProductTypestring

产品类型。

CloudApp
VersionIdstring

镜像版本。

iv-xxx
OnlineVersionIdstring

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

iv-xxxx
LatestVersionIdstring

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

iv-xxx
Statusstring

镜像状态。

INIT
ParentImageIdstring

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

imgc-xxx
ParentImageVersionstring

父镜像版本。

iv-xxx
BaseImageIdstring

基础镜像 ID。

imgc-xxx
BaseImageVersionstring

基础镜像版本。

iv-xxx
FotaVersionstring

FOTA 版本。

2.3.0-xxx
Languagestring

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

zh-CN
Platforminteger

镜像操作系统平台。

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

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

SystemDiskSizeinteger

系统盘大小。单位:GiB。

说明 系统盘大小不能小于镜像文件。
40
DataDiskSizeinteger

数据盘大小。单位:GiB。

100
AppListarray<object>

应用配置。

appListobject
AppIdstring

应用 ID。

ca-xxx
AppNamestring

应用名称。

应用名称
FeatureListarray

镜像特征标记列表。

featureListstring

镜像特征标记。

Builder
ImageCreateModestring

镜像创建类型

枚举值:
  • BY_SNAPSHOT_ID从快照创建或者只包含系统盘时
  • BUILDER_MANUAL手动生成镜像
  • INSTANCE_AUTO基于实例自动化生成镜像
  • BY_INSTANCE_ID从实例创建或者包含系统盘和数据盘时
BUILDER_MANUAL
ImageRegionListarray

地域。

imageRegionListstring

地域对象。

地域对象。
Distrostring

发行版名字。

Ubuntu 22.04 64
VersionNamestring

版本名称。

v0.1.0
ResourceInstanceCategorystring

镜像支持资源类型。

["eds.cpu.category"]
PlatformNamestring

系统平台名称。

Windows Server 2022
SupportedLanguageListarray

支持语言列表。

supportedLanguageListstring

支持语言。

zh-CN
VolumeEncryptionEnabledboolean

是否开启磁盘加密。

true
VolumeEncryptionKeystring

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

a7b3c0c8-xxxx
SessionTypestring

会话类型。

枚举值:
  • SINGLE_SESSION单会话
  • MULTIPLE_SESSION多会话
SINGLE_SESSION
ImageRegionDistributeListarray<object>

叠层有效地域信息。

ImageRegionDistributeListobject
ImageIdstring

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

imgc-xxx
RegionIdstring

支持地域。

cn-shanghai
Statusstring

状态。

INIT
VersionIdstring

镜像版本。

iv-xxx
Progressstring

进度百分比。

70%
FotaChannelstring
说明 此参数暂未对外开放使用。
镜像支持的fota渠道,暂未启用
CompatibleModeboolean

是否为兼容模式。

true
DriverListarray

驱动信息列表。

driverListstring

驱动列表。

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

总条数。

22
Successboolean

是否调用成功。

枚举值:
  • true调用成功
  • false调用失败
true
Codestring

错误码。

200
Messagestring

接口请求返回的信息。

success
RequestIdstring

请求 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"
        ]
      ]
    }
  ],
  "Count": 22,
  "Success": true,
  "Code": 200,
  "Message": "success",
  "RequestId": "8737D130-BFD0-5D51-96F6-C08EB1139A25"
}

错误码

HTTP status code错误码错误信息描述
400InternalErrorInternal error.内部错误
400InvalidBizTypeThe bizType parameter is invalid.业务类型不合法。
403Forbidden.NoPermissionYou are not authorized to access this page.您没有权限访问当前页面。

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