调用DescribeImages查询您可以使用的镜像资源。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | DescribeImages | 系统规定参数。取值:DescribeImages。 |
RegionId | String | 是 | cn-hangzhou | 镜像所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。 |
Status | String | 否 | Available | 查询指定状态的镜像,如果不配置此参数,默认只返回Available状态的镜像。取值范围:
默认值:Available。当前参数支持同时取多个值,值之间以半角逗号(,)隔开。 |
ImageId | String | 否 | m-bp1g7004ksh0oeuc**** | 镜像ID。 |
ShowExpired | Boolean | 否 | false | 订阅型镜像是否已经超过使用期限。 说明 该参数即将被弃用,为提高兼容性,请尽量使用其他参数。 |
SnapshotId | String | 否 | s-bp17ot2q7x72ggtw**** | 根据某一快照ID创建的自定义镜像。 |
ImageName | String | 否 | testImageName | 镜像名称。 |
ImageFamily | String | 否 | hangzhou-daily-update | 镜像族系名称,查询镜像时可通过设置该参数来过滤当前族系对应的镜像。 默认值:空。 说明 阿里云官方镜像关联的镜像族系信息请参见公共镜像概述。 |
ImageOwnerAlias | String | 否 | self | 镜像来源。取值范围:
默认值:空。 说明 空表示返回取值为system、self以及others的结果。 |
InstanceType | String | 否 | ecs.g5.large | 指定实例类型可以使用的镜像。 |
IsSupportIoOptimized | Boolean | 否 | true | 镜像是否可以运行在I/O优化实例上。 |
IsSupportCloudinit | Boolean | 否 | true | 镜像是否支持cloud-init。 |
OSType | String | 否 | linux | 镜像的操作系统类型。取值范围:
|
Architecture | String | 否 | i386 | 镜像的体系架构。取值范围:
|
PageNumber | Integer | 否 | 1 | 镜像资源列表的页码。 起始值:1。 默认值:1。 |
PageSize | Integer | 否 | 1 | 分页查询时设置的每页行数。 最大值:100。 默认值:10。 |
Usage | String | 否 | instance | 镜像是否已经运行在ECS实例中。取值范围:
|
DryRun | Boolean | 否 | false | 是否只预检此次请求。
默认值:false。 |
ActionType | String | 否 | CreateEcs | 镜像需要被使用到的场景。取值范围:
|
ResourceGroupId | String | 否 | rg-bp67acfmxazb4p**** | 自定义镜像所在的企业资源组ID。使用该参数过滤资源时,资源数量不能超过1000个。 说明 不支持默认资源组过滤。 |
Tag.N.key | String | 否 | null | 镜像的标签键。 说明 该参数即将被弃用,为提高兼容性,建议您使用另一个 Tag.N.Key 参数。 |
Tag.N.Key | String | 否 | TestKey | 镜像的标签键。N的取值范围:1~20。 使用一个标签过滤资源,查询到该标签下的资源数量不能超过1000个;使用多个标签过滤资源,查询到同时绑定了多个标签的资源数量不能超过1000个。如果资源数量超过1000个,请使用ListTagResources接口进行查询。 |
Tag.N.Value | String | 否 | TestValue | 镜像的标签值。N的取值范围:1~20。 |
Tag.N.value | String | 否 | null | 镜像的标签值。 说明 该参数即将被弃用,为提高兼容性,建议您使用另一个 Tag.N.Value 参数。 |
Filter.N.Key | String | 否 | CreationStartTime | 查询资源时的筛选键。取值范围:
|
Filter.N.Value | String | 否 | 2017-12-05T22:40Z | 查询资源时的筛选值。指定该参数时必须同时指定 |
IsPublic | Boolean | 否 | false | 是否查询已发布的社区镜像。取值范围:
默认值:false。 |
ImageOwnerId | Long | 否 | 1234567890 | 镜像所属的阿里云账号ID。该参数仅在查询共享镜像以及社区镜像时生效。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
PageSize | Integer | 1 | 当前分页包含多少条目。 |
PageNumber | Integer | 1 | 当前页码。 |
RequestId | String | 66189103-EDB2-43E2-BB60-BFF2B62F4EB8 | 请求ID。 |
TotalCount | Integer | 1 | 镜像总数。 |
RegionId | String | cn-hangzhou | 镜像所属地域ID。 |
Images | Array of Image | 镜像信息Images组成的集合。 |
|
Image | |||
CreationTime | String | 2019-11-15T06:07:05Z | 镜像的创建时间。 |
Status | String | Available | 镜像的状态。可能值:
|
ImageFamily | String | hangzhou-daily-update | 镜像族系名称。 |
Progress | String | 100% | 镜像完成的进度,单位为百分比。 |
IsCopied | Boolean | false | 是否是拷贝的镜像。 |
IsSupportIoOptimized | Boolean | true | 是否可以在I/O优化实例上运行。 |
ImageOwnerAlias | String | self | 镜像来源。可能值:
|
IsSupportCloudinit | Boolean | true | 是否支持Cloud Init。 |
ImageVersion | String | 2 | 镜像版本。 |
Usage | String | none | 有引用关系的资源类型。可能值:
|
IsSelfShared | String | true | 是否共享过该自定义镜像给其他用户。 |
Description | String | Archive log for Oracle | 描述信息。 |
Size | Integer | 60 | 镜像大小,单位:GiB。 |
ResourceGroupId | String | rg-bp67acfmxazb4p**** | 镜像所在的企业资源组ID。 |
Platform | String | Windows Server 2016 | 操作系统平台。 |
OSNameEn | String | Windows Server 2016 Data Center Edition 64bit Chinese Edition | 操作系统的英文显示名称。 |
ImageName | String | testImageName | 镜像的名称。 |
OSName | String | Windows Server 2016 数据中心版 64位中文版 | 操作系统的中文显示名称。 |
ImageId | String | m-bp1g7004ksh0oeuc**** | 镜像ID。 |
OSType | String | windows | 操作系统类型。可能值:
|
IsSubscribed | Boolean | false | 是否订阅了该镜像的商品码对应的镜像商品的服务条款。 |
ProductCode | String | test000**** | 云市场镜像中的镜像商品标识。 |
Architecture | String | x86_64 | 镜像系统架构类型。可能值:
|
BootMode | String | BIOS | 修改镜像的启动模式。可能值:
|
DiskDeviceMappings | Array of DiskDeviceMapping | 镜像下包含云盘和快照的映射关系。 |
|
DiskDeviceMapping | |||
Type | String | system | 镜像的类型。 |
ImportOSSBucket | String | testEcsImport | 导入镜像所属OSS的bucket。 |
Progress | String | 32% | 对于复制中的镜像,返回复制任务的进度。 |
SnapshotId | String | s-bp17ot2q7x72ggtw**** | 快照ID。 |
ImportOSSObject | String | imageImport | 导入镜像所属OSS的object。 |
Device | String | /dev/xvda | 云盘的设备信息,例如/dev/xvdb。 说明 该参数即将停止使用,为提高代码的兼容性,建议您尽量不要使用该参数。 |
Size | String | 60 | 云盘的大小。单位为GiB。 |
RemainTime | Integer | 233 | 对于复制中的镜像,返回复制任务的剩余时间,单位:秒。 |
Format | String | qcow2 | 镜像格式。 |
Tags | Array of Tag | 镜像的标签对信息。 |
|
Tag | |||
TagValue | String | Oracle | 镜像的标签值。 |
TagKey | String | DTS | 镜像的标签键。 |
IsPublic | Boolean | false | 是否为公开镜像。公开镜像包括阿里云提供的公共镜像以及您已发布为社区镜像的自定义镜像。可能值:
|
ImageOwnerId | Long | 1234567890 | 镜像所属的阿里云账号ID。该参数仅在查询共享镜像以及社区镜像时生效。 |
LoginAsNonRootSupported | Boolean | false | 当前镜像是否支持非root用户登录。可能值:
|
SupplierName | String | TestName | 社区镜像认证企业名称。 |
DetectionOptions | Object | 镜像检测相关结果。 |
|
Status | String | Processing | 镜像检测任务状态。可能值:
|
Items | Array of Item | 镜像检测项列表。 |
|
Item | |||
Name | String | Nvme | 镜像检测项名称。 |
Value | String | Supported | 镜像检测项结果。 |
RiskLevel | String | High | 导入的自定义镜像检测项是否存在风险,如果存在风险返回此字段,不存在风险则不返回。 风险等级可能值:
|
RiskCode | String | NVMe.NotInstalled | 检测项可能存在的缺陷。 |
Features | Object | 镜像特性相关属性。 |
|
NvmeSupport | String | supported | 镜像是否支持NVMe。可能值:
|
示例
请求示例
http(s)://ecs.aliyuncs.com/?Action=DescribeImages
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=1
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeImagesResponse>
<TotalCount>1</TotalCount>
<PageSize>1</PageSize>
<RequestId>66189103-EDB2-43E2-BB60-BFF2B62F4EB8</RequestId>
<PageNumber>1</PageNumber>
<Images>
<Image>
<ImageOwnerAlias>self</ImageOwnerAlias>
<IsSelfShared>true</IsSelfShared>
<Description>Archive log for Oracle</Description>
<Platform>Windows Server 2016</Platform>
<ResourceGroupId>rg-bp67acfmxazb4p****</ResourceGroupId>
<Size>60</Size>
<IsSubscribed>false</IsSubscribed>
<BootMode>BIOS</BootMode>
<OSName>Windows Server 2016 数据中心版 64位中文版</OSName>
<IsPublic>false</IsPublic>
<ImageId>m-bp1g7004ksh0oeuc****</ImageId>
<DetectionOptions/>
<Features>
<NvmeSupport>supported</NvmeSupport>
</Features>
<OSNameEn>Windows Server 2016 Data Center Edition 64bit Chinese Edition</OSNameEn>
<Tags>
<Tag>
<TagKey>DTS</TagKey>
<TagValue>Oracle</TagValue>
</Tag>
</Tags>
<LoginAsNonRootSupported>false</LoginAsNonRootSupported>
<Status>Available</Status>
<Progress>100%</Progress>
<Usage>none</Usage>
<Architecture>x86_64</Architecture>
<ProductCode>test000****</ProductCode>
<IsCopied>false</IsCopied>
<ImageFamily>hangzhou-daily-update</ImageFamily>
<IsSupportIoOptimized>true</IsSupportIoOptimized>
<IsSupportCloudinit>true</IsSupportCloudinit>
<ImageName>testImageName</ImageName>
<DiskDeviceMappings>
<DiskDeviceMapping>
<SnapshotId>s-bp17ot2q7x72ggtw****</SnapshotId>
<Type>system</Type>
<Progress>32%</Progress>
<Format>qcow2</Format>
<Device>/dev/xvda</Device>
<Size>60</Size>
<ImportOSSBucket>testEcsImport</ImportOSSBucket>
<ImportOSSObject>imageImport</ImportOSSObject>
</DiskDeviceMapping>
</DiskDeviceMappings>
<ImageVersion>2</ImageVersion>
<OSType>windows</OSType>
<CreationTime>2019-11-15T06:07:05Z</CreationTime>
</Image>
</Images>
<RegionId>cn-hangzhou</RegionId>
</DescribeImagesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalCount" : 1,
"PageSize" : 1,
"RequestId" : "66189103-EDB2-43E2-BB60-BFF2B62F4EB8",
"PageNumber" : 1,
"Images" : {
"Image" : [ {
"ImageOwnerAlias" : "self",
"IsSelfShared" : "true",
"Description" : "Archive log for Oracle",
"Platform" : "Windows Server 2016",
"ResourceGroupId" : "rg-bp67acfmxazb4p****",
"Size" : 60,
"IsSubscribed" : false,
"BootMode" : "BIOS",
"OSName" : "Windows Server 2016 数据中心版 64位中文版",
"IsPublic" : false,
"ImageId" : "m-bp1g7004ksh0oeuc****",
"DetectionOptions" : { },
"Features" : {
"NvmeSupport" : "supported"
},
"OSNameEn" : "Windows Server 2016 Data Center Edition 64bit Chinese Edition",
"Tags" : {
"Tag" : [ {
"TagKey" : "DTS",
"TagValue" : "Oracle"
} ]
},
"LoginAsNonRootSupported" : false,
"Status" : "Available",
"Progress" : "100%",
"Usage" : "none",
"Architecture" : "x86_64",
"ProductCode" : "test000****",
"IsCopied" : false,
"ImageFamily" : "hangzhou-daily-update",
"IsSupportIoOptimized" : true,
"IsSupportCloudinit" : true,
"ImageName" : "testImageName",
"DiskDeviceMappings" : {
"DiskDeviceMapping" : [ {
"SnapshotId" : "s-bp17ot2q7x72ggtw****",
"Type" : "system",
"Progress" : "32%",
"Format" : "qcow2",
"Device" : "/dev/xvda",
"Size" : "60",
"ImportOSSBucket" : "testEcsImport",
"ImportOSSObject" : "imageImport"
} ]
},
"ImageVersion" : "2",
"OSType" : "windows",
"CreationTime" : "2019-11-15T06:07:05Z"
} ]
},
"RegionId" : "cn-hangzhou"
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
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. | 您指定的实例规格不存在,或者您没有权限操作此规格的实例。 |
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. | 内部错误,请重试。 |
访问错误中心查看更多错误码。