本接口用于制作私有镜像,支持:
作为异步接口,调用成功,只是说明云平台收到了制作请求,镜像是否制作成功需要通过异步任务查询接口查询该任务的执行状态,具体请参考异步任务查询。
外部镜像文件的限制请参见“准备镜像文件(Windows)”或“准备镜像文件(Linux)”。
POST /v2/cloudimages/action
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
系统盘镜像名称。name参数说明请参考镜像属性。 |
description |
否 |
String |
镜像描述信息。_description参数说明请参考镜像属性。支持字母、数字、中文等,不支持回车、<、>,长度不能超过1024个字符。默认为空。 |
instance_id |
是 |
String |
用于制作镜像的源云服务器ID。 如何获取云服务器ID:
|
data_images |
否 |
Array of objects |
需要转换的数据盘信息,其中,当使用云服务器上的数据盘进行私有数据盘镜像创建时,该字段必选,详情请参见表1。 如果不是用于制作数据盘镜像,该字段默认为空。 说明:
当需要用数据盘创建数据盘镜像时,此表中的其他参数(如name、description、tags)如果有值,系统以data_images中的值为准,不允许再输入instance_id。 |
tags |
否 |
Array of strings |
镜像标签列表。默认为空。 tags和image_tags只能使用一个。 |
image_tags |
否 |
Array of objects |
新规范的镜像标签列表。默认为空。 tags和image_tags只能使用一个。 |
enterprise_project_id |
否 |
String |
表示当前镜像所属的企业项目。
|
max_ram |
否 |
Integer |
表示镜像支持的最大内存,单位为MB。 |
min_ram |
否 |
Integer |
表示镜像支持的最小内存,单位为MB,默认为0,表示不受限制。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
镜像名称。name参数说明请参考镜像属性。 |
description |
否 |
String |
镜像描述信息。_description参数说明请参考镜像属性。支持字母、数字、中文等,不支持回车、<、>,长度不能超过1024个字符。默认为空。 |
os_type |
否 |
String |
操作系统类型。 取值为Linux、Windows、Other。 |
os_version |
否 |
String |
操作系统版本。 使用上传至OBS桶中的外部镜像文件制作镜像时生效,具体取值见相关参数取值列表。 说明:
如果上传的文件为ISO格式,则该参数为必填参数。 当“is_quick_import”的值为“true”时,即使用镜像文件快速导入方式导入系统盘镜像,则该参数为必填参数。 |
image_url |
是 |
String |
OBS桶中外部镜像文件地址。 在使用OBS桶的外部镜像文件制作镜像时生效且为必选字段。格式为<OBS桶名>:<OBS镜像文件名称>。 说明:
此处的OBS桶和镜像文件的存储类别必须是OBS标准存储。 |
min_disk |
是 |
Integer |
最小系统盘大小。 在使用OBS桶的外部镜像文件制作镜像时生效且为必选字段。取值为40~1024GB。 |
is_config |
否 |
Boolean |
是否自动配置。 取值为true或false。 如果需要后台自动配置,取值为true,否则为false。默认取值为false。 后台自动配置的内容请参考“注册镜像(Linux)”。 |
cmk_id |
否 |
String |
创建加密镜像的用户主密钥,具体取值请参考“查看密钥”获取。 |
tags |
否 |
Array of strings |
镜像标签列表。默认为空。 tags和image_tags只能使用一个。 |
image_tags |
否 |
Array of objects |
新规范的镜像标签列表。默认为空。tags和image_tags只能使用一个。 |
type |
否 |
String |
镜像的类型。 取值为ECS、BMS、FusionCompute、Ironic、IsoImage。默认使用“ECS”。
|
enterprise_project_id |
否 |
String |
表示当前镜像所属的企业项目。
|
max_ram |
否 |
Integer |
表示镜像支持的最大内存,单位为MB。 |
min_ram |
否 |
Integer |
表示镜像要求的最小内存,单位为MB,默认为0,表示不受限制。 |
data_images |
否 |
Array of objects |
需要导入的数据盘信息。 外部镜像文件最多可携带3块数据盘,此时系统会创建1块系统盘、3块数据盘。 详情请参见表2。 说明:
|
is_quick_import |
否 |
Boolean |
是否使用镜像文件快速导入方式,导入系统盘镜像。
关于镜像文件快速导入的约束与限制请参见镜像文件快速导入。 |
architecture |
否 |
String |
镜像的架构类型。取值包括:
默认使用“x86”。 说明:
当架构类型为arm时,镜像引导方式将自动转为UEFI。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
镜像名称。 name参数说明请参见镜像属性。 |
description |
否 |
String |
镜像描述信息。默认为空。 支持字母、数字、中文等,不支持回车、<、>,长度不能超过1024个字符。 _description参数说明请参见镜像属性。 |
image_url |
是 |
String |
OBS桶中外部镜像文件地址。 格式为“<OBS桶名>:<OBS镜像文件名称>”。 说明:
此处的OBS桶和镜像文件的存储类别必须是OBS标准存储。 |
min_disk |
是 |
Integer |
最小数据盘大小。 单位:GB 取值范围:1~2048GB |
is_quick_import |
否 |
Boolean |
当前数据盘镜像是否使用镜像文件快速导入方式,创建数据盘镜像。
关于镜像文件快速导入的约束与限制请参见镜像文件快速导入。 |
tags |
否 |
Array of strings |
镜像标签列表。默认为空。 tag的参数说明请参见镜像标签数据格式。 tags和image_tags只能使用一个。 |
image_tags |
否 |
Array of objects |
新规范的镜像标签列表。默认为空。 image_tags参数说明请参见镜像标签数据格式。 tags和image_tags只能使用一个。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
系统盘镜像名称。 name参数说明请参见镜像属性。 |
volume_id |
是 |
String |
数据盘的卷ID。 |
os_version |
是 |
String |
操作系统版本。 os_version的具体取值请参见相关参数取值列表,请严格按照列表要求填写该值,否则可能会引起制作的系统盘镜像不可用。 制作系统盘镜像过程中,如果系统能获取到卷中的操作系统,则以卷中的操作系统版本为准,此时,设置的os_version无效。如果系统无法获取到卷中的操作系统,此时,系统以输入的os_version版本为准。 |
type |
否 |
Sting |
镜像的类型。 取值为ECS、BMS、FusionCompute、Ironic。
默认使用ECS。 |
description |
否 |
String |
镜像描述信息,默认为空。 参数说明请参见镜像属性。
|
min_ram |
否 |
Integer |
镜像运行需要的最小内存,单位为MB。 参数取值依据云服务器的规格限制,默认设置为0。 云服务器的规格限制,请参见规格清单。 |
max_ram |
否 |
Integer |
镜像运行需要的最大内存,单位为MB。 参数取值依据云服务器的规格限制,默认设置为0。 云服务器的规格限制,请参见规格清单。 |
tags |
否 |
Array of strings |
镜像标签列表,默认为空。 tags和image_tags只能使用一个。 |
image_tags |
否 |
Array of objects |
新规范的镜像标签列表,默认为空。 tags和image_tags只能使用一个。 |
enterprise_project_id |
否 |
String |
表示当前镜像所属的企业项目。
|
POST https://{Endpoint}/v2/cloudimages/action
{
"name": "ims_test",
"description": "云服务器制作系统盘镜像",
"instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
"tags": [
"aaa.111",
"bbb.333",
"ccc.444"
]
}
POST https://{Endpoint}/v2/cloudimages/action
1 2 3 4 5 6 7 8 9 10 11 | {
"data_images": [{"name": "ims_data_image_test",
"description": "云服务器数据卷制作数据盘镜像",
"volume_id": "c5dfbd0c-bf0a-4798-a453-61dc6b54aa30",
"tags": [
"aaa.111",
"bbb.333",
"ccc.444"
]
}]
}
|
POST https://{Endpoint}/v2/cloudimages/action
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | {
"name": "ims_test_file",
"description": "OBS文件制作镜像",
"image_url": "ims-image:centos70.qcow2",
"os_version": "CentOS 7.0 64bit",
"is_config_init": true,
"min_disk": 40,
"is_config": true,
"tags": [
"aaa.111",
"bbb.333",
"ccc.444"
]
}
|
POST https://{Endpoint}/v2/cloudimages/action
{
"name": "ims_test",
"description": "云服务器制作系统盘镜像",
"instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
"image_tags": [
{
"key": "key2",
"value": "value2"
},
{
"key": "key1",
"value": "value1"
}
]
}
POST /v2/cloudimages/action
1 2 3 4 5 6 7 | {
"data_images": [{"name": "ims_data_image_test",
"description": "云服务器数据卷制作数据盘镜像",
"volume_id": "c5dfbd0c-bf0a-4798-a453-61dc6b54aa30",
"image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]
}]
}
|
POST https://{Endpoint}/v2/cloudimages/action
1 2 3 4 5 6 7 8 9 10 | {
"name": "ims_test_file",
"description": "OBS文件制作镜像",
"image_url": "ims-image:centos70.qcow2",
"os_version": "CentOS 7.0 64bit",
"is_config_init": true,
"min_disk": 40,
"image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]
}
|
POST https://{Endpoint}/v2/cloudimages/action
1 2 3 4 5 6 7 8 9 10 11 12 | {
"name": "ims_test",
"description": "数据卷制作系统盘镜像",
"volume_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
"type": "ECS",
"os_version": "CentOS 7.0 64bit",
"tags": [
"aaa.111",
"bbb.333",
"ccc.444"
]
}
|
POST https://{Endpoint}/v2/cloudimages/action
1 2 3 4 5 6 7 8 | {
"name": "ims_test",
"description": "数据卷制作系统盘镜像",
"volume_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
"type": "ECS",
"os_version": "CentOS 7.0 64bit",
"image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]
}
|
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
异步任务ID。 详情请参见异步任务查询。 |
STATUS CODE 200
1 2 3 | {
"job_id": "8a12fc664fb4daa3014fb4e581380005"
}
|
返回值 |
说明 |
---|---|
400 Bad Request |
请求错误,具体返回错误码请参见错误码。 |
401 Unauthorized |
鉴权失败。 |
403 Forbidden |
没有操作权限。 |
404 Not Found |
找不到资源。 |
500 Internal Server Error |
服务内部错误。 |
503 Service Unavailable |
服务不可用。 |
API风格说明 当前ECS服务对外开放两类风格的API: ECS服务自定义规范的API(以下...
??提到慕尼黑,大家第一个想到总是啤酒节,其实慕尼黑的文化同样闻名世界。慕尼...
排查思路 无法通过远程桌面连接裸金属服务器时,我们推荐您按照以下思路排查问题...
案例背景 高校健康打卡项目发起于北京大学软件与微电子学院,是该学院张齐勋老师...
公司介绍 我们公司是全球法律服务整合平台,已有的4万多名律师遍布全国359个城市...
云虚拟主机 可以干什么?云 虚拟主机 可以是搭 建网站 的重要产品,可用来存放网...
3月24日,腾讯发布2020年Q4及全年财报,其中金融科技及企业服务第四季收入385亿...
客户简介 全民直播是一家涵盖游戏、娱乐、户外等多领域泛娱乐的直播平台。2015年...
客户简介 趣医网(quyiyuan.com)创立于2014年,为京颐集团重要成员企业之一,是...
注册了 域名 不备案可以吗?可以的。 注册域名 并不是一定要备案的,只有搭 建网...