查询镜像的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecd:DescribeImages | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 | cn-hangzhou |
| MaxResults | integer | 否 | 分页查询时每页行数。
| 10 |
| NextToken | string | 否 | 下一个查询开始的 Token，NextToken 为空表示没有下一个。 | caeba0bbb2be03f84eb48b699f0a4883 |
| ImageType | string | 否 | 镜像类型。 枚举值：
| SYSTEM |
| ImageStatus | string | 否 | 镜像状态。 枚举值：
| Available |
| GpuCategory | boolean | 否 | 是否为 GPU 类型镜像。 枚举值：
| false |
| ProtocolType | string | 否 | 协议类型。 枚举值：
| ASP |
| LanguageType | string | 否 | 操作系统语言。 枚举值：
| en-US |
| DesktopInstanceType | string | 否 | 云电脑规格。可调用 DescribeDesktopTypes 获取该参数。 | ecd.graphics.xlarge |
| ImageId | array | 否 | 镜像 ID。可设置一个或多个。 | |
| string | 否 | 镜像 ID。 | m-gx2x1dhsmusr2**** | |
| OsType | string | 否 | 操作系统类型，默认为 枚举值：
| Windows |
| GpuDriverVersion | string | 否 | GPU 驱动版本号。 | 417.22 |
| SessionType | string | 否 | 会话类型。 枚举值：
| SINGLE_SESSION |
| FotaVersion | string | 否 | 镜像版本信息。 | 0.0.3-R-20220616.133609 |
| ImageName | string | 否 | 镜像名称。 | Win_01 |
返回参数
示例
正常返回示例
JSON格式
{
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"RequestId": "4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB",
"Images": [
{
"CreationTime": "2018-01-10T01:01:10Z",
"Status": "Available",
"Progress": "100%",
"DataDiskSize": 150,
"ImageType": "SYSTEM",
"Description": "This is description.",
"Size": 40,
"OsType": "WINDOWS",
"ProtocolType": "ASP",
"Name": "testImageName",
"ImageId": "m-gx2x1dhsmusr2****",
"GpuCategory": false,
"SupportedLanguages": [
"en-US"
],
"GpuDriverVersion": 417.22,
"AppVersion": "1.0.0",
"VolumeEncryptionEnabled": false,
"VolumeEncryptionKey": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
"SharedCount": 1,
"SessionType": "MULTIPLE_SESSION",
"UpdateTime": "2021-12-22T02:48:43Z",
"Platform": "Windows Server 2019"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-06-13 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2021-10-28 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2021-10-28 | OpenAPI 返回结构发生变更 | 查看变更详情 |