查询可用镜像
描述
查询用户可以使用的镜像列表。显示出的镜像资源列表包括用户自己私有的镜像,阿里云提供系统资源,其他公共的镜像资源和镜像市场的镜像,镜像市场的镜像需要先到镜像市场的网站上订阅后才能进行创建云服务器实例。此接口支持分页查询,查询结果包括可使用的镜像资源的总数和当前页的镜像资源。每页的数量默认为 10 条。
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 系统规定参数,取值:DescribeImages |
RegionId | String | 是 | 实例所属于的 Region ID |
ImageId | String | 否 | 镜像 ID,最多 100 个Id,用半角逗号字符隔开。 |
Status | String | 否 | 镜像状态, 取值:
取值说明:
|
SnapshotId | String | 否 | 创建镜像的快照 ID |
ImageName | String | 否 | 镜像的名称 |
ImageOwnerAlias | string | 否 | 镜像所有者别名。 取值:
不设置该参数说明不使用该参数进行过滤条件 取值说明:
|
Usage | String | 否 | 有引用关系的资源类型,instance | none |
Tag.n.Key | String | 否 | 标签 key,n 从 1 开始,最大为 5。 不允许为空字符串。 |
Tag.n.Value | String | 否 | 标签 value,n 从 1 开始,最大为 5。 允许为空字符串。 |
PageNumber | Integer | 否 | 实例状态列表的页码,起始值为 1,默认值为 1 |
PageSize | Integer | 否 | 分页查询时设置的每页行数,最大值 100 行,默认值为 10 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
RegionId | String | 镜像所属地域 Id |
TotalCount | Integer | 列表条条目数 |
PageNumber | Integer | 当前页码 |
PageSize | Integer | 当前分页包含多少条目 |
Images | ImageType | 镜像信息 ImageType 组成的集合 |
错误码
错误代码 | 描述 | Http 状态码 | 语义 |
---|---|---|---|
MissingParameter | The input parameter "RegionId" that is mandatory for processing this request is not supplied. | 400 | 缺少 RegionId 字段 |
InvalidImageOwnerAlias.ValueNotSupported | The specified ImageOwnerAlias value is not supported. | 400 | 无效的 ImageOwnerAlias 取值 |
InvalidParameter | The specified parameter "PageNumber" is not valid. | 400 | 指定的 PageNumber 不合法 |
InvalidParameter | The specified parameter "PageSize" is not valid. | 400 | 指定的 PageSize 不合法 |
InvalidUsage | The specifed Usage is not valid | 404 | 指定的 Usage 不合法 |
示例
请求示例
https://ecs.aliyuncs.com/?Action=DescribeImages
&RegionId=cn-hangzhou
&<公共请求参数>
返回示例
JSON格式
{
"Images": {
"Image": [
{
"Architecture": "x86_64",
"CreationTime": "2015-05-06T09:01:32Z",
"DiskDeviceMappings": {
"DiskDeviceMapping": [
{
"Device": "/dev/xvda",
"Size": "20"
}
]
},
"ImageId": "suse11sp3_64_20G_aliaegis_20150428.vhd",
"ImageName": "suse11sp3_64_20G_aliaegis_20150428.vhd",
"ImageOwnerAlias": "system",
"ImageVersion": "1",
"IsCopied": false,
"IsSubscribed": false,
"OSName": "SUSE Linux Enterprise Server 11 SP3 64位",
"OSType": "linux",
"Platform": "SUSE",
"Progress": "100%",
"Size": 20,
"Status": "Available",
"Usage": "instance"
}
]
}
"PageNumber": 1,
"PageSize": 1,
"RegionId": "cn-hangzhou",
"RequestId": "49CBCED4-C9B9-4851-BEB5-8FB5E5169E30",
"TotalCount": 24
}