查询镜像信息列表。
详细操作说明请参考帮助文档:镜像概述
GET
方式请求,最终参数会转换为 URL
上的参数,但是 HTTP
协议下的 GET
请求参数长度是有大小限制的,使用者需要注意参数超长的问题。GET
https://vm.jdcloud-api.com/v1/regions/{regionId}/images
名称 | 类型 | 是否必需 | 示例值 | 描述 |
---|---|---|---|---|
regionId | String | 是 | cn-north-1 | 地域ID。 |
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
imageSource | String | 否 | public | 镜像来源,如果没有指定 ids 参数,此参数必传。可选值:public :官方镜像。thirdparty :镜像市场镜像。private :用户自己的私有镜像。shared :其他用户共享的镜像。 |
offline | Boolean | 否 | 查询已经下线的镜像时使用。 只有查询 imageSource=public 或 imageSource=thirdparty 时,此参数才有意义,其它情况下此参数无效。指定 ids 查询时,此参数无效。可选值:true :已下线;false :未下线。 |
|
platform | String | 否 | CentOS | 根据镜像的操作系统发行版查询。 可选值: Ubuntu、CentOS、Windows Server 。 |
ids | String[ ] | 否 | ["img-m5s0****29","img-m5s0****30"] | 指定镜像ID查询,如果指定了此参数,其它参数可以不传。 |
imageName | String | 否 | image | 根据镜像名称模糊查询。 |
rootDeviceType | String | 否 | cloudDisk | 根据镜像支持的系统盘类型查询。可选值:localDisk :本地系统盘镜像;cloudDisk : 云盘系统盘镜像。 |
launchPermission | String | 否 | ownerOnly | 根据镜像的使用权限查询,仅当 imageSource 为 private 时有效。可选值:specifiedUsers :存在共享关系镜像。ownerOnly :不存在共享关系的镜像。 |
status | String | 否 | ready | 根据镜像状态查询。参考 镜像状态 |
pageNumber | Integer | 否 | 1 | 页码;默认为1。 |
pageSize | Integer | 否 | 20 | 分页大小; 默认为20;取值范围:[10, 100]。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
result | Result | 响应结果。 | |
requestId | String | c2hmmaan8w06w19qcdfuic4w03f7ft2d | 请求ID。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
images | Image[ ] | 镜像列表。 | |
totalCount | Integer | 本次查询可匹配到的总记录数,使用者需要结合 pageNumber 和 pageSize 计算是否可以继续分页。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
imageId | String | img-m5s0****29 | 镜像ID。 |
name | String | image-test | 镜像名称。 |
platform | String | CentOS | 镜像的操作系统平台名称。 可能值: Ubuntu、CentOS、Windows Server、Other Linux、Other Windows 。 |
osVersion | String | 8.2 | 镜像的操作系统版本。 |
architecture | String | x86_64 | 镜像架构。可能值:x86_64、i386 。 |
systemDiskSizeGB | Integer | 40 | 镜像系统盘大小。 |
imageSource | String | public | 镜像来源,可能值:public :官方镜像。thirdparty :镜像市场镜像。private :用户自己的私有镜像。shared :其他用户共享的镜像。 |
osType | String | linux | 镜像的操作系统类型。可能值:windows、linux 。 |
status | String | ready | 镜像状态。参考 镜像状态。 |
createTime | String | 2020-08-21 11:36:36 | 镜像的创建时间。 |
sizeMB | Integer | 3244 | 镜像文件的实际大小。 |
desc | String | 镜像描述。 | |
ownerPin | String | 该镜像拥有者的用户PIN。 | |
launchPermission | String | all | 镜像的使用权限。可能值:all :所有人均可使用(官方镜像和镜像市场镜像会返回此值)。specifiedUsers :镜像存在共享关系,仅拥有者和共享对象可以使用。ownerOnly :镜像不存在共享关系,仅拥有者可以使用。 |
systemDisk | InstanceDiskAttachment | 镜像系统盘配置。 | |
dataDisks | InstanceDiskAttachment[ ] | 镜像数据盘配置列表。 | |
snapshotId | String | snapshot-h8u1****36 | 创建云盘系统盘所使用的快照ID。系统盘类型为本地盘的镜像,此参数为空。 |
rootDeviceType | String | cloudDisk | 镜像支持的系统盘类型。可能值:localDisk :本地盘系统盘。cloudDisk :云硬盘系统盘。 |
progress | String | 100 | 镜像复制和镜像类型转换时的进度,仅显示数值,单位为百分比。 |
offline | Boolean | 镜像的上下线状态。仅官方镜像和云市场镜像返回此值。可能值:true :已下线;false :未下线。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
diskCategory | String | cloud | 磁盘类型。可能值: 系统盘: local :本地盘;cloud :云硬盘。数据盘: cloud :云硬盘。 |
autoDelete | Boolean | true | 是否随实例一起删除,即删除实例时是否自动删除此磁盘。此参数仅对按配置计费的非多点挂载云硬盘生效。可能值:true :随实例删除。false :不随实例删除。 |
localDisk | LocalDisk | 仅本地系统盘返回此参数。对应 diskCategory=local 。 |
|
cloudDisk | Disk | 云硬盘配置。对应 diskCategory=cloud 。 |
|
deviceName | String | vdb | 磁盘逻辑挂载点。 系统盘:默认为vda。 数据盘:返回值: [vdb~vdbm] 。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
diskType | String | 本地系统盘镜像不返回此参数。 | |
diskSizeGB | Integer | 120 | 磁盘容量。单位为 GiB。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
diskType | String | ssd.gp1 | 云硬盘类型。可能值: ssd.gp1,ssd.io1,hdd.std1
|
diskSizeGB | Integer | 云硬盘容量,单位为 GiB。 | |
iops | Integer | 该云硬盘实际应用的iops值。 | |
snapshotId | String | 创建该云硬盘的快照ID。 | |
encrypted | Boolean | 制作快照的磁盘是否为加密盘。 |
GET
/v1/regions/cn-north-1/images?pageNumber=1&pageSize=10&imageSource=public&platform=CentOS
{ "requestId": "5dfbb22e5f44a6798476bc2408c3bb68", "result": { "images": [ { "architecture": "x86_64", "createTime": "2021-01-28 16:49:05", "desc": "", "imageId": "img-m5s0****29", "imageSource": "public", "launchPermission": "all", "name": "CentOS 8.2 64位", "osType": "linux", "osVersion": "8.2", "ownerPin": "admin", "platform": "CentOS", "progress": "100", "rootDeviceType": "cloudDisk", "sizeMB": 2494, "snapshotId": "snapshot-h8u1****36", "status": "ready", "systemDisk": { "autoDelete": true, "cloudDisk": { "diskSizeGB": 40, "diskType": "ssd.gp1", "encrypt": false, "encrypted": false, "snapshotId": "snapshot-h8u1****36" }, "deviceName": "vda", "diskCategory": "cloud" }, "systemDiskSizeGB": 40, "uefiSupport": false }, { "architecture": "x86_64", "createTime": "2019-12-30 11:05:02", "desc": "", "imageId": "img-m5s0****30", "imageSource": "public", "launchPermission": "all", "name": "CentOS 7.6 64位", "osType": "linux", "osVersion": "7.6", "ownerPin": "admin", "platform": "CentOS", "rootDeviceType": "cloudDisk", "sizeMB": 0, "snapshotId": "snapshot-h8u1****36", "status": "ready", "systemDisk": { "autoDelete": true, "cloudDisk": { "diskSizeGB": 40, "diskType": "ssd.gp1", "encrypt": false, "encrypted": false, "snapshotId": "snapshot-h8u1****36" }, "deviceName": "vda", "diskCategory": "cloud" }, "systemDiskSizeGB": 40, "uefiSupport": true } ], "totalCount": 2 } }
HTTP状态码 | 错误码 | 描述 | 错误解析 |
---|---|---|---|
200 | OK | ||
400 | FAILED_PRECONDITION | Parameter ImageSource missing | 未指定 imageSource 参数。 |
400 | OUT_OF_RANGE | PageSize out of range | 分页大小超出规定范围。 |
500 | INTERNAL | Internal server error | 系统内部错误,请稍后重试。如果多次尝试失败,请提交工单。 |
500 | UNKNOWN | Unknown server error | 服务暂时不可用,请稍后重试。如果多次尝试失败,请提交工单。 |