调用DescribeImages接口，并可以指定ImageId、ImageFamily、InstanceType等参数，查询您可以使用的镜像资源。
接口说明
- 您可以查询的镜像资源包括您的自定义镜像、阿里云提供的公共镜像、云市场镜像以及其他阿里云用户主动共享给您的共享镜像。
- 支持分页查询，查询结果包括可使用的镜像资源的总数和当前页的镜像资源。每页的数量默认为 10 条。
- 通过阿里云 CLI 调用 API 时，不同数据类型的请求参数取值必须遵循格式要求。更多信息，请参见 CLI 参数格式说明。
- 当查询阿里云官方提供的镜像或共享镜像（ImageOwnerAlias 指定 system 或 others）时，本次请求可忽略 RAM 鉴权规则。更多信息，请参见鉴权规则。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecs:DescribeImages | get | *Image acs:ecs:{#regionId}:{#accountId}:image/**Image acs:ecs:{#regionId}:{#accountId}:image/{#imageId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 镜像所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| Status | string | 否 | 查询指定状态的镜像，如果不配置此参数，默认只返回 Available 状态的镜像。取值范围：
默认值：Available。当前参数支持同时取多个值，值之间以半角逗号（,）隔开。 | Available |
| ImageId | string | 否 | 镜像 ID。 | m-bp1g7004ksh0oeuc**** |
| ShowExpired | boolean | 否 | 订阅型镜像是否已经超过使用期限。 | false |
| SnapshotId | string | 否 | 根据某一快照 ID 创建的自定义镜像。 | s-bp17ot2q7x72ggtw**** |
| ImageName | string | 否 | 镜像名称。 | testImageName |
| ImageFamily | string | 否 | hangzhou-daily-update | |
| ImageOwnerAlias | string | 否 | 镜像来源。取值范围：
默认值：空。 说明
空表示返回取值为 system、self 以及 others 的结果。
| self |
| InstanceType | string | 否 | 为指定的实例规格查询可以使用的镜像。 | ecs.g5.large |
| IsSupportIoOptimized | boolean | 否 | 镜像是否可以运行在 I/O 优化实例上。 | true |
| IsSupportCloudinit | boolean | 否 | 镜像是否支持 cloud-init。 | true |
| OSType | string | 否 | 镜像的操作系统类型。取值范围：
| linux |
| Architecture | string | 否 | 镜像的体系架构。取值范围：
| i386 |
| PageNumber | integer | 否 | 镜像资源列表的页码。 起始值：1。 默认值：1。 | 1 |
| PageSize | integer | 否 | 分页查询时设置的每页行数。 最大值：100。 默认值：10。 | 10 |
| Usage | string | 否 | 镜像是否已经运行在 ECS 实例中。取值范围：
| instance |
| DryRun | boolean | 否 | 是否只预检此次请求。
默认值：false。 | false |
| ActionType | string | 否 | 镜像需要被使用到的场景。取值范围：
| CreateEcs |
| ResourceGroupId | string | 否 | 自定义镜像所在的企业资源组 ID。使用该参数过滤资源时，资源数量不能超过 1000 个。 说明
不支持默认资源组过滤。
| rg-bp67acfmxazb4p**** |
| Tag | array<object> | 否 | 标签列表。 | |
| object | 否 | 标签列表。 | ||
| key | string | 否 | 镜像的标签键。 说明
该参数即将被弃用，为提高兼容性，建议您使用另一个 Tag.N.Key参数。
| null |
| Key | string | 否 | 镜像的标签键。N 的取值范围：1~20。 使用一个标签过滤资源，查询到该标签下的资源数量不能超过 1000 个；使用多个标签过滤资源，查询到同时绑定了多个标签的资源数量不能超过 1000 个。如果资源数量超过 1000 个，请使用 ListTagResources 接口进行查询。 | TestKey |
| Value | string | 否 | 镜像的标签值。N 的取值范围：1~20。 | TestValue |
| value | string | 否 | 镜像的标签值。 说明
该参数即将被弃用，为提高兼容性，建议您使用另一个 Tag.N.Value参数。
| null |
| Filter | array<object> | 否 | 查询资源时的筛选条件列表。 | |
| object | 否 | 查询资源时的筛选条件列表。 | ||
| Key | string | 否 | 查询资源时的筛选键。取值范围：
| CreationStartTime |
| Value | string | 否 | 查询资源时的筛选值。指定该参数时必须同时指定 | 2017-12-05T22:40Z |
| IsPublic | boolean | 否 | 是否查询已发布的社区镜像。取值范围：
默认值：false。 | false |
| ImageOwnerId | long | 否 | 镜像所属的阿里云账号 ID。该参数仅在查询共享镜像以及社区镜像时生效。 | 20169351435666**** |
返回参数
示例
正常返回示例
JSON格式
{
"PageSize": 1,
"PageNumber": 1,
"RequestId": "66189103-EDB2-43E2-BB60-BFF2B62F4EB8",
"TotalCount": 1,
"RegionId": "cn-hangzhou",
"Images": {
"Image": [
{
"CreationTime": "2019-11-15T06:07:05Z",
"Status": "Available",
"ImageFamily": "hangzhou-daily-update",
"Progress": "100%",
"IsCopied": false,
"IsSupportIoOptimized": true,
"ImageOwnerAlias": "self",
"IsSupportCloudinit": true,
"ImageVersion": "2",
"Usage": "none",
"IsSelfShared": "true",
"Description": "Archive log for Oracle",
"Size": 60,
"ResourceGroupId": "rg-bp67acfmxazb4p****",
"Platform": "Windows Server 2016",
"OSNameEn": "Windows Server 2016 Data Center Edition 64bit Chinese Edition",
"ImageName": "testImageName",
"OSName": "Windows Server 2016 数据中心版 64位中文版",
"ImageId": "m-bp1g7004ksh0oeuc****",
"OSType": "windows",
"IsSubscribed": false,
"ProductCode": "test000****",
"Architecture": "x86_64",
"BootMode": "BIOS",
"DiskDeviceMappings": {
"DiskDeviceMapping": [
{
"Type": "system",
"ImportOSSBucket": "testEcsImport",
"Progress": "32%",
"SnapshotId": "s-bp17ot2q7x72ggtw****",
"ImportOSSObject": "imageImport",
"Device": "/dev/xvda",
"Size": "60",
"RemainTime": 233,
"Format": "qcow2"
}
]
},
"Tags": {
"Tag": [
{
"TagValue": "Oracle",
"TagKey": "DTS"
}
]
},
"IsPublic": false,
"ImageOwnerId": 1234567890,
"LoginAsNonRootSupported": false,
"SupplierName": "TestName",
"DetectionOptions": {
"Status": "Processing",
"Items": {
"Item": [
{
"Name": "Nvme",
"Value": "Supported",
"RiskLevel": "High",
"RiskCode": "NVMe.NotInstalled"
}
]
}
},
"Features": {
"NvmeSupport": "supported"
}
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidImageOwnerAlias.ValueNotSupported | The specified ImageOwnerAlias value is not supported. | 无效的镜像所有者别名，请您检查该参数是否正确。 |
| 400 | InvalidParamter | Invalid Parameter. | 输入的参数无效。 |
| 400 | InvalidTag.Mismatch | The specified Tag.n.Key and Tag.n.Value are not match. | 指定的 Tag.N.Key 和 Tag.N.Value 不匹配。 |
| 400 | InvalidTagCount | The specified tags are beyond the permitted range. | 指定的标记超出取值范围。 |
| 400 | InvalidInstanceType.ValueNotSupported | The specified InstanceType does not exist or beyond the permitted range. | 您指定的实例规格不存在，或者您没有权限操作此规格的实例。 |
| 400 | InvalidFilterValue.NetworkType | The specified networkType value in the Filter is invalid. | 过滤器中指定的网络类型值无效。 |
| 403 | CurrentAccount.NotSupportPublicImage | Public image is not supported for current account. | 当前用户不支持使用公共镜像。 |
| 404 | InvalidFilterKey.NotFound | The specified Filter Key is not found. | Filter的Key参数无效。 |
| 404 | InvalidFilterValue | The specified Filter Value is not valid. | Filter中的Value无效。 |
| 404 | InvalidUsage | The specified Usage is not valid. | Usage参数无效。 |
| 404 | InvalidOSType | The specified OSType is not valid. | OSType参数无效。 |
| 404 | InvalidArchitecture | The specified Architecture is not valid. | Architecture参数无效。 |
| 500 | InternalError | The request processing has failed due to some unknown error. | 内部错误，请重试。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-09-26 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-03-30 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2021-07-26 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |