接口功能介绍
使用指定的云主机数据盘来创建一份私有镜像。
接口约束
接口请求成功需至少满足:
1. 可创建的私有镜像数量未达上限。
2. 要创建的镜像的名称不能与以下名称重复:
- 已有的私有镜像的名称(可使用查询可以使用的镜像资源接口来查询您可使用的镜像资源);
- 处于 pending 任务状态的创建私有镜像(镜像文件)任务的镜像名称(可使用查询创建私有镜像(镜像文件)任务列表接口来查询使用镜像文件来创建私有镜像的任务列表)。
3. 在创建镜像前,所指定的云主机应处于关机状态。可使用查询一台或多台云主机详细信息接口来查询您的云主机的详细信息。
4. 在创建镜像过程中,请勿对所指定的云主机及相关联资源进行其他操作。
URI
POST /v4/image/create-from-data-disk
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
dataDiskID | 是 | String | 指定的云主机的数据盘 ID。可使用查询云主机的云硬盘列表接口来查询您的云主机的云硬盘 | 8888a888-b888-8888-a888-baee8d8ce88c | |
imageName | 是 | String | 镜像名称。注意:长度为 2~32 个字符,只能由数字、字母、- 组成,不能以数字、- 开头,且不能以 - 结尾。 | CentOS-test | |
instanceID | 是 | String | 云主机 ID。可使用查询云主机列表接口来查询您的云主机列表。 | 88f888ea-88ff-88ec-a8bc-888888888fe8 | |
regionID | 是 | String | 资源池 ID。可使用资源池列表查询接口来查询您可见的资源池的列表。 | 88f8888888dd88ec888888888d888d8b | |
description | 否 | String | 镜像描述信息。注意:长度为 1~128 个字符。 | Test CentOS | |
projectID | 否 | String | 企业项目 ID,默认值 0。 | 0 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码,取值范围(值:描述): 800:成功 900:失败 |
800 | |
error | String | 错误码(product.module.code 三段式码)。 | ||
errorCode | String | 同“error”参数。 | ||
message | String | 响应状态描述(一般为英文)。 | ||
description | String | 响应状态描述(一般为中文)。 | ||
returnObj | Object | 返回参数。 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
images | Array of Objects | 镜像列表。 | image |
表 image
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
architecture | String | 镜像系统架构,取值范围(值:描述): aarch64:AArch64 架构,仅支持 UEFI 启动方式 x86_64:x86_64 架构,支持 BIOS 和 UEFI 启动方式 |
x86_64 | |
azName | String | 可用区名称。 | az1 | |
bootMode | String | 启动方式,取值范围(值:描述): bios:BIOS 启动方式 uefi:UEFI 启动方式 |
bios | |
containerFormat | String | 容器格式。 | bare | |
createdTime | Integer | 镜像创建时间,epoch 秒数,即从 1970-01-01 00:00:00 UTC 到当前时间的秒数。 | 1664409600 | |
description | String | 镜像描述信息。 | Test CentOS | |
destinationUser | String | 共享镜像的接受人。 | 888888@chinatelecom.cn | |
diskFormat | String | 磁盘格式,取值范围(值:描述): qcow2:QCOW2 格式 raw:RAW 格式 vhd:VHD 格式 vmdk:VMDK 格式 |
raw | |
diskID | String | 私有镜像来源的系统盘/数据盘 ID。 | 8888a888-b888-8888-a888-baee8d8ce88c | |
diskSize | Integer | 磁盘容量,单位为 GB。 | 40 | |
imageClass | String | 镜像类别,取值范围(值:描述): BMS:物理机 ECS:云主机 |
ECS | |
imageID | String | 镜像 ID。 | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
imageName | String | 镜像名称。 | CentOS-test | |
imageType | String | 镜像类型,取值范围(值:描述): (空或空字符串):系统盘镜像 data_disk_image:数据盘镜像 |
||
maximumRAM | Integer | 最大内存。 | 0 | |
minimumRAM | Integer | 最小内存。 | 0 | |
osDistro | String | 操作系统的发行版名称。 | centos | |
osType | String | 操作系统类型,取值范围(值:描述): linux:Linux 系操作系统 windows:Windows 系操作系统 |
linux | |
osVersion | String | 操作系统版本。 | 7.8 | |
projectID | String | 项目 ID。 | 0 | |
sharedListLength | Integer | 私有镜像的共享列表的总记录数。 | 0 | |
size | Integer | 镜像大小,单位为 byte。 | 42949672960 | |
sourceServerID | String | 私有镜像来源的云主机/物理机 ID。 | 88f888ea-88ff-88ec-a8bc-888888888fe8 | |
sourceUser | String | 共享镜像的发起人。 | 777777@chinatelecom.cn | |
status | String | 镜像状态,取值范围(值:描述): accepted:已接受共享镜像 active:正常 deactivated:已弃用 deactivating:弃用中 deleted:已删除 deleting:删除中 error:错误 importing:导入中 killed:上传出错,镜像不可读 pending_delete:等待删除中 queued:排队中 reactivating:取消弃用中 rejected:已拒绝共享镜像 saving:保存中 syncing:同步中 uploading:上传中 waiting:等待接受/拒绝共享镜像 |
waiting | |
tags | String | 标签。一种场景是标记公共 GPU 镜像适用规格。 | ||
updatedTime | Integer | 镜像更新时间,epoch 秒数,即从 1970-01-01 00:00:00 UTC 到当前时间的秒数。 | 1664409600 | |
visibility | String | 镜像可见类型,应始终为 private(私有镜像)。 | private |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"dataDiskID": "8888a888-b888-8888-a888-baee8d8ce88c",
"imageName": "CentOS-test",
"instanceID": "88f888ea-88ff-88ec-a8bc-888888888fe8",
"regionID": "88f8888888dd88ec888888888d888d8b",
"description": "Test CentOS",
"projectID": "0"
}
响应示例
{
"statusCode": 800,
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"returnObj": {
"totalCount": 1,
"images": [
{
"architecture": "x86_64",
"azName": null,
"bootMode": "bios",
"containerFormat": "bare",
"createdTime": 1664409600,
"description": "Test CentOS",
"destinationUser": null,
"diskFormat": "raw",
"diskID": "8888a888-b888-8888-a888-baee8d8ce88c",
"diskSize": 40,
"imageClass": "ECS",
"imageID": "8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa",
"imageName": "CentOS-test",
"imageType": "data_disk_image",
"maximumRAM": 0,
"minimumRAM": 0,
"osDistro": "centos",
"osType": "linux",
"osVersion": "7.8",
"projectID": "0",
"sharedListLength": 0,
"size": 42949672960,
"sourceServerID": "88f888ea-88ff-88ec-a8bc-888888888fe8",
"sourceUser": null,
"status": "queued",
"tags": null,
"updatedTime": 1664409600,
"visibility": "private"
}
]
}
}
状态码
请参考 状态码
错误码
请参考 错误码