查询镜像信息。
调试
您可以在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 | 否 | 镜像状态,用户查询对应状态的镜像,默认是查询所有未删除状态的镜像。 枚举值:
| INIT |
| ImageType | string | 否 | 镜像类型。 枚举值:
| User |
| PackageType | string | 否 | 镜像封装类型。 枚举值:
| Ecs |
| OsType | string | 否 | 镜像操作系统类型。 枚举值:
| Windows |
| BizType | integer | 否 | 业务类型。暂不对外透出使用。 枚举值:
| 1 |
| ProductType | string | 否 | 产品类型。 枚举值:
| CloudApp |
| ProtocolType | string | 否 | 镜像协议类型。 枚举值:
| ASP |
| PageSize | integer | 否 | 分页查询时每页的行数。最大值:100。默认值:10。 | 10 |
| PageNumber | integer | 否 | 当前页码。 | 1 |
| ProductTypeList | array | 否 | 当镜像支持多个产品时可以支持的产品列表。 | |
| string | 否 | 产品类型。 枚举值:
| CloudApp | |
| BizTypeList | array | 否 | 所有业务类型列表,暂不对外透出使用。 | |
| integer | 否 | 业务类型。根据您使用的业务填写使用。 枚举值:
| 1 | |
| FeatureList | array | 否 | 镜像支持的特征列表。 | |
| string | 否 | 镜像支持的特征。 枚举值:
| GPU | |
| LanguageType | string | 否 | 语言。 枚举值:
| zh-CN |
| ResourceInstanceType | string | 否 | 查找某些固定规格的镜像。 | eds.enterprise_office.2c4g |
| FotaVersion | string | 否 | 镜像版本信息。 | 2.0.3-xxxx |
| PlatformName | string | 否 | 操作系统平台名称。 枚举值:
| 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 |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InternalError | Internal error. | 内部错误 |
| 400 | InvalidBizType | The bizType parameter is invalid. | 业务类型不合法。 |
| 403 | Forbidden.NoPermission | You are not authorized to access this page. | 您没有权限访问当前页面。 |
访问错误中心查看更多错误码。
