CDN加速

镜像查询

更新时间:2021-06-16 10:55:27

适用产品:边缘云主机

接口描述

查询用户可以使用的镜像列表。显示出的镜像资源列表包括用户自定义的镜像及边缘计算平台提供的公共镜像。

请求参数

JSON
参数名称类型必填描述
sortKeystring排序的字段名称,可以有多个,取值: name、createdAt、type、size、state
sortDirstring排序方向,必须跟在sortKey后面出现,取值: desc:降序,默认值 asc:升序
limitinteger每个页面显示条数,默认是20
markerstring从marker指定的镜像id开始查询
idsstring镜像 ID。单次最多查询 100 条 ID,ID 之间用半角逗号字符“,”隔开。
namestring镜像名称
typestring镜像属主,是公共镜像还是用户自定义镜像,取值: COMMON:官方镜像 SNAPSHOT:用户快照镜像 CUSTOM:用户自定义镜像
statestring镜像状态,取值: ACTIVE:可用状态 BUILDING:创建中 INACTIVE:不可用(如创建失败等)

返回参数

JSON
参数名称类型描述
imagesarray镜像信息数组
idstring镜像唯一标识,全局唯一
namestring镜像名称
typestring镜像属主
createdAtstring镜像创建时间,如:2017-11-04 14:17:41
sizestring镜像大小,单位是GB
statestring镜像状态

示例

JSON
示例说明
请求示例
复制
GET /images
返回示例
复制
{
    "images": [
        {
            "name": "cirros-0.3.2-x86_64-disk",
            "createdAt": "2017-11-01 17:07:06",
            "id": "1bea47ed-f6a9-463b-b423-14b9cca9ad27",
            "type": "COMMON",
            "size": 13167616,
            "state": "ACTIVE"
        },
        {
            "name": "F17-x86_64-Ubuntu16.0",
            "createdAt": "2017-11-07 17:07:06",
            "id": "781b3762-9469-4cec-b58d-3349e5de4e9c",
            "type": "CUSTOM",
            "size": 2214167616,
            "state": "INACTIVE"
        }
    ]
}