单盘创建镜像
更新时间 2025-09-25 16:10:17
最近更新时间: 2025-09-25 16:10:17
接口功能介绍
为未挂载的数据盘/系统盘创建私有镜像。
接口约束
1、可创建的私有镜像数量未达上限。单个区域最多创建10个私有镜像。
2、要创建的镜像的名称不能与已有私有镜像名称重复。
3、在创建镜像前，所指定的云硬盘应处于“未挂载”状态。
4、加密盘不支持创建镜像。
URI
POST /v4/ebs/create-image-ebs
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID。 | 81f7728662dd11ec810800155d307d5b | |
| diskID | 是 | String | 要创建镜像的云硬盘ID。 | 83b27404-97fe-4407-a930-25432b7e754e | |
| imageName | 是 | String | 镜像名称。注意：长度为2~32个字符，只能由数字、字母、“-”组成，不能以数字、“-”开头，且不能以“-”结尾。 | img-ebs-83b2 | |
| description | 否 | String | 镜像描述信息。注意：长度为1~128个字符，不允许换行，不允许空白字符开头或结尾。 | private image for ebs-83b2 | |
| projectID | 否 | String | 企业项目ID，默认值“0”。 | 0 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败)。 | 800 | |
| message | String | 成功或失败时的描述，一般为英文描述。 | image name invalid: 2-32 chars | |
| description | String | 成功或失败时的描述，一般为中文描述。 | 镜像名称无效：长度为2-32 | |
| returnObj | Object | 返回数据结构体。 | returnObj | |
| errorCode | String | 业务细分码，为Product.Module.Code三段式码。请参考错误码。 | ebs.parameter.imageName | |
| error | String | 业务细分码，为Product.Module.Code三段式大驼峰码。请参考错误码。 | Ebs.Parameter.ImageName | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| images | Array of Objects | 镜像列表。 | images | |
| 表 images |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| imageID | String | 镜像ID。 | ca55fd48-1da6-4b19-b0b9-7e04f2fb9ac6 | |
| imageName | String | 镜像名称。 | img-ebs-83b2 | |
| imageType | String | 镜像类型。取值范围（值：描述）： （空或空字符串）：系统盘镜像； data_disk_image：数据盘镜像。 | data_disk_image | |
| size | Integer | 镜像大小，单位为byte，返回时正在队列中或者创建中，值为0。 | 0 | |
| status | String | 镜像状态，见枚举值。 | active | |
| visibility | String | 镜像可见类型，始终为private（私有镜像）。 | private | |
| diskID | String | 私有镜像来源的系统盘/数据盘ID。 | 83b27404-97fe-4407-a930-25432b7e754e | |
| diskSize | Integer | 磁盘容量，单位为GB。 | 40 | |
| diskFormat | String | 磁盘格式，取值范围（值：描述）： qcow2：QCOW2格式； raw：RAW格式； vhd：VHD格式； vmdk：VMDK格式。 | raw | |
| azName | String | 可用区名称。 | null | |
| projectID | String | 企业项目。 | 0 | |
| description | String | 镜像描述。 | private image for ebs-83b2 | |
| architecture | String | 镜像系统架构，取值范围（值：描述）： aarch64：AArch64架构，仅支持UEFI启动方式； x86_64：x86_64架构，支持BIOS和UEFI启动方式。 | null | |
| containerFormat | String | 容器格式。 | bare | |
| createdTime | Long | 镜像创建时间，epoch秒数，即从1970-01-01 00:00:00 UTC到当前时间的秒数。 | 1742697592340 | |
| updatedTime | Long | 镜像更新时间，epoch秒数，即从1970-01-01 00:00:00 UTC到当前时间的秒数。 | 1755916780000 | |
| maximumRAM | Integer | 最大内存。 | 0 | |
| minimumRAM | Integer | 最小内存。 | 0 | |
| osDistro | String | 操作系统的发行版名称。 | null | |
| osType | String | 操作系统类型，取值范围（值：描述）： linux：Linux系操作系统； windows：Windows系操作系统。 | null | |
| osVersion | String | 操作系统版本。 | null | |
| sourceServerID | String | 私有镜像来源的云主机/物理机ID。 | null |
枚举参数
无
请求示例
请求url
无
请求头header
{
}
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"diskID": "c2383648-94f6-466d-afb7-6079602e2701",
"imageName": "test_create_image",
"projectID": "0",
"description": "this is description"
}
响应示例
{
"httpstatus": 200,
"httpresult": {
"returnObj": {
"images": [
{
"maximumRAM": 0,
"projectID": "0",
"sourceServerID": "",
"osType": "",
"size": 0,
"minimumRAM": 0,
"imageID": "ffa5ee40-601d-4a74-b324-f7b3953447f7",
"imageName": "test_create_image",
"diskSize": 10,
"diskID": "c2383648-94f6-466d-afb7-6079602e2701",
"status": "queued",
"osDistro": "",
"diskFormat": "raw",
"description": "this is description",
"visibility": "private",
"azName": "",
"osVersion": "",
"containerFormat": "bare",
"updatedTime": 1736911488850,
"imageType": "data_disk_image",
"architecture": "",
"createdTime": 1736911487716
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
}
状态码
请参考 状态码
错误码
请参考 错误码
