功能介绍
使用 云服务器 、 云服务 器备份或者 云备份 制作整机 镜像 。作为异步接口，调用成功，只是说明后台收到了制作整机镜像的请求，镜像是否制作成功需要通过异步任务查询接口查询该任务的执行状态，具体请参考异步任务查询。
约束与限制（使用云服务器制作整机镜像）
- 创建整机镜像时，请确保云服务器已完成相关配置，否则可能导致整机镜像创建云服务器失败。
详情请参见“创建私有镜像前云服务器、 裸金属服务器 或镜像文件需要完成哪些初始化配置？”。
- 使用Windows操作系统云服务器制作整机镜像时，不允许云服务器存在跨区卷，否则制作的整机镜像创建云服务器时可能会导致数据丢失。
- 使用Linux操作系统云服务器制作整机镜像时，不允许云服务器存在由多个物理卷组成的卷组、或由多个物理卷组成的逻辑卷，否则制作的整机镜像创建云服务器时可能会造成数据丢失。
- 带有 专属分布式存储 磁盘的云服务器不支持创建整机镜像。
- 整机镜像不支持如下操作：不能发布为市场镜像，不允许导出、区域内复制。
- 使用Windows操作系统云服务器制作整机镜像时，需修改云服务器SAN策略为OnlineAll类型。否则可能导致使用镜像创建云服务器时，云服务器磁盘处于脱机状态。
Windows操作系统SAN策略分为三种类型：OnlineAll、OfflineShared、OfflineInternal
表1 Windows操作系统SAN策略类型 类型
说明
OnlineAll
表示所有新发现磁盘都置于在线模式。
OfflineShared
表示所有共享总线上（比如FC、ISCSI）的新发现磁盘都置于离线模式，非共享总线上的磁盘都置于在线模式。
OfflineInternal
表示所有新发现磁盘都置于离线模式。
约束与限制（使用云服务器备份制作整机镜像）
- 创建整机镜像时，请确保创建该云服务器备份所属的弹性云服务器已完成相关配置，否则可能导致整机镜像创建云服务器失败。
- 在云服务器关机状态下，制作整机镜像的过程中，用户不能启动云服务器。
- 使用云服务器备份创建整机镜像时，不允许云服务器备份存在共享卷。
- 使用云服务器备份创建整机镜像时，云服务器备份必须是可用状态，且每个云服务器备份只能创建一个整机镜像。
- 整机镜像不支持如下操作：不能发布为市场镜像，不允许导出、区域内复制。
约束与限制（使用云备份制作整机镜像）
- 创建整机镜像前，请确保创建该云备份所属的弹性云服务器已完成相关配置，否则可能导致整机镜像创建云服务器失败。
- 每个云备份只能创建一个整机镜像。
- 在云服务器关机状态下，制作整机镜像的过程中，用户不能启动云服务器。
- 通过云备份创建的整机镜像可以共享给其他租户。但是，如果这个云备份是由其他租户共享的，那么创建的整机镜像不支持共享。
- 整机镜像不支持如下操作：不能发布为市场镜像，不允许导出、区域内复制。
调试
您可以在API Explorer中调试该接口。
URI
POST /v1/cloudimages/wholeimages/action
请求消息
- 使用云服务器创建整机镜像的请求参数
参数
是否必选
参数类型
描述
name
是
String
镜像名称。name参数说明请参考镜像属性。
description
否
String
镜像描述信息。_description参数说明请参考镜像属性。
tags
否
Array of strings
镜像标签列表。默认为空。
tags和image_tags只能使用一个。
image_tags
否
Array of objects
新规范的镜像标签列表。默认为空。
tags和image_tags只能使用一个。
instance_id
是
String
云服务器ID。使用云服务器制作整机镜像时使用此参数。
如何获取云服务器ID：
- 登录控制台。
- 选择“计算 > 弹性云服务器”。
- 在云服务器列表栏，单击源云服务器名称，在详情页查看ID。
ent erp rise_project_id
否
String
表示当前镜像所属的企业项目。
- 取值为0或无该值，表示属于default企业项目。
- 取值为UUID，表示属于该UUID对应的企业项目。
关于企业项目ID的获取及企业项目特性的详细信息，请参考“企业中心总览”。
max_ram
否
Integer
表示镜像支持的最大内存，单位为MB，默认不设置。
min_ram
否
Integer
表示镜像支持的最小内存，单位为MB，默认为0。
vault_id
否
String
表示云服务器待加入的或已加入的存储库的ID。
使用云服务器创建整机镜像的过程为：先创建一个备份，再将备份创建为整机镜像。如果这个备份为CBR，vault_id为必填项；如果备份为CSBS，vault_id参数可不填。
存储库ID可以从云备份服务控制台获取，或者参考“查询存储库列表”查询。
- 使用云服务器备份或云备份创建整机镜像的请求参数
参数
是否必选
参数类型
描述
name
是
String
镜像名称。name参数说明请参考镜像属性。
description
否
String
镜像描述信息。_description参数说明请参考镜像属性。
tags
否
Array of strings
镜像标签列表。默认为空。
tags和image_tags只能使用一个。
image_tags
否
Array of objects
新规范的镜像标签列表。默认为空。
tags和image_tags只能使用一个。
backup_id
是
String
云服务器备份ID或者云备份ID。
如何获取云服务器备份ID：- 登录管理控制台。
- 选择“存储 > 云服务器备份”。
- 在备份列表栏，展开备份详情，查看备份ID。
如何获取云备份ID：- 登录管理控制台。
- 选择“存储 > 云备份”。
- 在云服务器备份页面，单击“备份副本”页签，在备份列表中查看备份ID。
enterprise_project_id
否
String
表示当前镜像所属的企业项目。
- 取值为0或无该值，表示属于default企业项目。
- 取值为UUID，表示属于该UUID对应的企业项目。
关于企业项目ID的获取及企业项目特性的详细信息，请参考“企业中心总览”。
max_ram
否
Integer
表示镜像支持的最大内存，单位为MB，默认不设置。
min_ram
否
Integer
表示镜像支持的最小内存，单位为MB，默认为0，表示不受限制。
whole_image_type
否
String
表示创建整机镜像的方式。
- 若通过CBR服务的备份创建整机镜像，该参数必填，设置为CBR，此时，backup_id为云备份ID。
- 若通过CSBS服务的备份创建整机镜像，该参数可为空，取默认值CSBS，此时，backup_id为云服务器备份ID。
请求示例
- 使用云服务器制作整机镜像，其中，镜像标签数据格式为tags，虚拟机ID为“877a2cda-ba63-4e1e-b95f-e67e48b6129a”。
POST https://{Endpoint}/v1/cloudimages/wholeimages/action { "name": "instance_whole_image", "description": "云服务器制作镜像", "instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a", "vault_id": "de9fcf45-11b2-432c-8562-5c5428574600", "tags": [ "aaa.111", "bbb.333", "ccc.444" ] }
- 使用云服务器制作整机镜像，其中，镜像标签数据格式为image_tags，虚拟机ID为“877a2cda-ba63-4e1e-b95f-e67e48b6129a”。
POST https://{Endpoint}/v1/cloudimages/wholeimages/action { "name": "instance_whole_image", "description": "云服务器制作镜像", "instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a", "vault_id": "de9fcf45-11b2-432c-8562-5c5428574600", "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}] }
- 使用云服务器备份或云备份制作整机镜像，其中，镜像标签数据格式为tags，备份ID为"9b27efab-4a17-4c06-bfa2-3e0cf021d3c3"。
POST https://{Endpoint}/v1/cloudimages/wholeimages/action { "name": "backup_whole_image", "description": "云备份制作镜像", "backup_id": "9b27efab-4a17-4c06-bfa2-3e0cf021d3c3", "whole_image_type": "CBR", "tags": [ "aaa.111", "bbb.333", "ccc.444" ] }
- 使用云服务器备份或云备份制作整机镜像，其中，镜像标签数据格式为image_tags，备份ID为"9b27efab-4a17-4c06-bfa2-3e0cf021d3c3"。
POST https://{Endpoint}/v1/cloudimages/wholeimages/action { "name": "backup_whole_image", "description": "云备份制作镜像", "backup_id": "9b27efab-4a17-4c06-bfa2-3e0cf021d3c3", "whole_image_type": "CBR", "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}] }
响应消息
- 响应参数
参数
参数类型
描述
job_id
String
异步任务ID。
详情请参见异步任务查询。
- 响应样例
STATUS CODE 200
{ "job_id": "4010a32b5f909853015f90aaa24b0015" }
返回值
- 正常
- 异常
返回值
说明
400 Bad Request
请求错误，具体返回错误码请参见错误码。
401 Unauthorized
鉴权失败。
403 Forbidden
没有操作权限。
404 Not Found
找不到资源。
500 Internal Server Error
服务内部错误。
503 Service Unavailable
服务不可用。
