接口功能介绍
根据实例ID查询所使用的镜像信息
接口约束
无
URI
GET /v4/ebm/instance-image
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 区域ID | 81f7728662dd11ec810800155d307d5b | |
| azName | 是 | String | 可用区名称或者 default。您可以调用 https://www.ctyun.cn/document/10026730/10040590 获取资源池信息，查询结果中zoneList内返回可用区名称，若查询结果中zoneList为空，即为单可用区，本字段填写default | az1 | |
| instanceUUID | 是 | String | 实例UUID | ss-qyjtenwqho0gfztts5vscc2l5efi |
请求参数
请求头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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| results | Aarray of Objects | 分页明细,元素类型是results,定义请参考表results | results |
表results
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| nameZh | String | 名称 | openEuler | |
| format | String | 规格;包括squashfs,qcow2 | squashfs | |
| imageType | String | 镜像类型;包括standard,private,shared | standard | |
| version | String | 版本 | 20.03 | |
| imageUUID | String | 镜像uuid | im - z6tbsixttkdlepk6i5zz3fhk9ugs | |
| nameEn | String | 名称 | openEuler | |
| layoutType | String | 布局类型;包括lvm,direct | lvm | |
| os | Object | 操作系统 | os |
表os
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| uuid | String | 操作系统uuid | o - sjaeghvo9i2c9va6yiwfgochrkmc | |
| superUser | String | 超级管理员 | root | |
| platform | String | 平台 | openEuler | |
| version | String | 版本 | 20.03 | |
| architecture | String | 支持的机器类型 | x86_64 | |
| nameEn | String | 名称 | openEuler | |
| bits | Integer | 比特数 | 64 | |
| osType | String | 操作系统类别 | linux | |
| nameZh | String | 名称 | openEuler |
请求示例
Query
/v4/ebm/instance-image?regionID=bb9fdb42056f11eda&azName=az1&instanceUUID=ss-qyjtenwqho0gfztts5vscc2l5efi
响应示例
{
"returnObj": {
"results":
[{
"nameZh": "openEuler ",
"format ": "squashfs ",
"version ": "20.03 ",
"imageUUID ": "im - z6tbsixttkdlepk6i5zz3fhk9ugs ",
"layoutType ": "lvm ",
"nameEn ": "openEuler ",
"os ":
{
"superUser ": "root ",
"uuid ": "o - sjaeghvo9i2c9va6yiwfgochrkmc ",
"platform ": "openEuler ",
"version ": "20.03 ",
"architecture ": "x86_64 ",
"osType ": null,
"nameEn ": "openEuler ",
"bits ": 64,
"nameZh ": "openEuler "
},
"imageType ": "standard "}
]},
"statusCode ": 800,
"errorCode": "",
"message": "SUCCESS",
"description": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
错误码
| 错误码 | 描述 |
|---|---|
| Ebm.ImageType.NotValid | 请求参数非法 |
| Ebm.Instance.NotFound | 物理机不存在 |
| Ebm.ImageList.NotFound | 镜像不存在 |
| Ebm.Common.CheckError | 内部错误，请重试 |
| 其他 | 参见公共错误码说明 |
