接口功能介绍
通过参数查询物理机可支持的镜像
接口约束
无
URI
GET /v4/ebm/image-list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 区域ID | 81f7728662dd11ec810800155d307d5b | |
| azName | 是 | String | 可用区名称或者 default。您可以调用 https://eop.ctyun.cn/ebp/ctapiDocument/search?sid=25&api=5855&data=87 获取资源池信息，查询结果中zoneList内返回可用区名称，若查询结果中zoneList为空，即为单可用区，本字段填写default | az2 | |
| deviceType | 是 | String | 套餐类型 | physical.t2.large | |
| imageUUID | 否 | String | 镜像id | im-rgk4fo8wo3spbf9p8geyurs1ydpx | |
| imageType | 否 | String | 镜像类型，可选择：private(私有镜像)、standard(标准镜像)、shared(共享镜像)；默认为standard | private | |
| osName | 否 | String | 操作系统名词，例如windows、ubuntu、centos等 | windows | |
| osVersion | 否 | String | 操作系统版本 | server-2016 | |
| osType | 否 | String | 操作系统类型，支持linux、windows | windows | |
| pageNo | 否 | Integer | 页码，默认值:1 | 2 | |
| pageSize | 否 | Integer | 每页记录数目，取值范围:[1~10000]，默认值:10，单页最大记录不超过10000 | 2 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败)，默认值:800 | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | Ebm.ImageType.NotValid | |
| message | String | 响应结果的描述，一般为英文描述 | error request | |
| description | String | 响应结果的描述，一般为中文描述 | 错误请求 | |
| returnObj | Object | 返回参数，参考表returnObj | {} | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| currentCount | Integer | 当前页数量 | 2 | |
| totalCount | Integer | 总记录数 | 10 | |
| totalPage | Integer | 总页数 | 5 | |
| results | Array of Objects | 分页明细，元素类型是results，定义请参考表results | [{},{}] | results |
表results
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| nameZh | String | 中文名称 | windows-server | |
| format | String | 规格;包括squashfs,qcow2 | qcow2 | |
| imageType | String | 镜像类型;包括standard,private,shared，默认为standard | standard | |
| version | String | 版本 | 2016 | |
| imageUUID | String | 镜像uuid | im-rgk4fo8wo3spbf9p8geyurs1ydpx | |
| isShared | Boolean | 镜像是否共享 | false | |
| nameEn | String | 英文名称 | windows-server | |
| layoutType | String | 布局类型;包括lvm,direct | lvm | |
| os | Object | 操作系统 | {} | os |
表os
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| uuid | String | 操作系统uuid | o-c3nmtx1mhus38xwekv1wm8u4gse1 | |
| superUser | String | 超级管理员 | Administrator | |
| platform | String | 平台 | windows | |
| version | String | 版本 | server-2016 | |
| architecture | String | 支持的机器类型 | x86_64 | |
| nameEn | String | 英文名称 | windows | |
| bits | Integer | 比特数 | 64 | |
| osType | String | 操作系统类别 | windows | |
| nameZh | String | 中文名称 | windows系统服务器版-2016 |
请求示例
Query
/v4/ebm/image-list?regionID=bb9fdb42056f11eda1610242ac110002&azName=az2&deviceType=physical.t2.large&pageNo=2&pageSize=2
响应示例
{
"statusCode": 800,
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"returnObj": {
"totalCount": 10,
"currentCount": 2,
"totalPage": 5,
"results": [{
"nameZh": "windows-server",
"format": "qcow2",
"imageType": "standard",
"isShared": false,
"version": "2016",
"imageUUID": "im-rgk4fo8wo3spbf9p8geyurs1ydpx",
"nameEn": "windows-server",
"layoutType": "lvm",
"os": {
"uuid": "o-c3nmtx1mhus38xwekv1wm8u4gse1",
"superUser": "Administrator",
"platform": "windows",
"version": "server-2016",
"architecture": "x86_64",
"nameEn": "windows",
"bits": 64,
"osType": "windows",
"nameZh": "windows系统服务器版-2016"
}
}, {
"nameZh": "windows-server",
"format": "qcow2",
"imageType": "standard",
"isShared": false,
"version": "2019",
"imageUUID": "im-rgk4fo8wo3spbf9p8geyurs1y801",
"nameEn": "windows-server",
"layoutType": "lvm",
"os": {
"uuid": "o-c3nmtx1mhus38xwekv1wm8u4g801",
"superUser": "Administrator",
"platform": "windows",
"version": "server-2019",
"architecture": "x86_64",
"nameEn": "windows",
"bits": 64,
"osType": "windows",
"nameZh": "windows系统服务器版-2019"
}
}]
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
错误码
| 错误码 | 描述 |
|---|---|
| Ebm.ImageType.NotValid | 请求参数非法 |
| Ebm.ImageType.NotFound | 镜像不存在 |
| Ebm.Common.CheckError | 内部错误，请重试 |
| 其他 | 参见公共错误码说明 |
