1)接口功能介绍
查询可用的镜像。
2)接口约束
无。
3)URI
GET /v1/listImage。
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
imageType | 是 | String | 镜像类型,取值有PUBLIC-公有,PRIVATE-私有,SHARE-共享 | PUBLIC | |
platform | 否 | String | 平台类型: ALL:全部, WINDOWS: windows平台, CENTOS: CentOS平台, UBUNTU: Ubuntu平台, DEBIAN: debian平台, OTHER: 其他平台,不填默认是ALL | ALL | |
imageName | 否 | String | 镜像名称,模糊查询。不填则查询所有镜像。 | testVmImg | |
imageFormat | 否 | String | 镜像格式,常见的有iso,raw,qcow2等,不填查所有种类. | qcow2 | |
page | 否 | Integer | 第几页,默认第一页 | 1 | |
perPageNum | 否 | Integer | 每页显示的记录条数,默认为10条 | 10 |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | Object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数名称 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
page | 是 | Integer | 当前页数 | 1 | |
perPageNum | 是 | Integer | 每页显示的记录条数 | 10 | |
totalPage | 是 | Integer | 总页数 | 2 | |
total | 是 | Integer | 记录总个数 | 11 | |
vmImageList | 是 | List | 镜像列表 | vmImageList |
表 vmImageList
参数名称 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
vmImageId | 是 | Integer | 虚机镜像ID | 1 | |
imageName | 是 | String | 虚机镜像名称 | CentOS7.7 | |
imageFormat | 是 | String | 镜像格式 | qcow2 | |
osVersion | 是 | String | 操作系统版本 | v7.71 | |
osArch | 是 | String | 操作系统架构 | adm64 | |
osSize | 是 | Integer | 系统大小,单位KB | 9961472 | |
platform | 是 | String | 平台类型 | LINUX | |
systemBits | 是 | String | 系统位数 | BITS64 | |
imageType | 是 | String | 镜像类型 | PUBLIC | |
created | 是 | String | 虚机镜像创建时间(Unix时间戳,秒) | 1605597430 | |
updated | 是 | String | 虚机镜像更新时间(Unix时间戳,秒) | 1606183008 | |
sysDiskSize | 是 | Integer | 系统盘容量 单位:G | 10 | |
comment | 是 | String | 备注 | xxx |
6)请求示例
GET https://{host}/v1/listImage?imageType=PUBLIC&platform=CENTOS&imageName=&imageFormat=&page=1&perPageNum=1
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"vmImageList": [
{
"sysDiskSize": 8,
"comment": "",
"userId": 0,
"updated": "1666683278",
"osArch": "amd64",
"vmImageId": 1,
"platform": "CENTOS",
"imageName": "CentOS7.6",
"imageType": "PUBLIC",
"systemBits": "BITS64",
"osSize": 406673,
"osVersion": " 7.6",
"created": "1617847327",
"imageFormat": "qcow2"
}
],
"totalPage": 5,
"total": 15,
"page": 1,
"perPageNum": 1
},
"requestId": "99a2f8ec-ef8b-4e14-9a06-254de8278429"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |