文档首页/ 镜像服务 IMS/ API参考 (巴黎区域) / API/ 镜像/ 制作镜像

更新时间：2024-03-01 GMT+08:00

查看PDF

制作镜像

功能介绍

本接口用于制作私有镜像，支持：

使用云服务器制作私有镜像（系统盘镜像/数据盘镜像）。
使用上传至OBS桶中的外部镜像文件制作系统盘镜像。

作为异步接口，调用成功，只是说明云平台收到了制作请求，镜像是否制作成功需要通过异步任务查询接口查询该任务的执行状态，具体请参考异步任务查询。

不支持用户导出Windows、SUSE、Red Hat、Oracle Linux和Ubuntu操作系统的公共镜像和此类公共镜像创建的私有镜像。

URI

POST /v2/cloudimages/action

请求消息

使用云服务器制作镜像（系统盘镜像/数据盘镜像）时的请求参数

参数	是否必选	参数类型	描述
name	是	String	系统盘镜像名称。name参数说明请参考镜像属性。
description	否	String	镜像描述信息。description参数说明请参考镜像属性。支持字母、数字、中文等，不支持回车、<、>，长度不能超过1024个字符。默认为空。
instance_id	是	String	用于制作镜像的源云服务器ID。如何获取云服务器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只能使用一个。
max_ram	否	Integer	表示镜像支持的最大内存，单位为MB。
min_ram	否	Integer	表示镜像支持的最小内存，单位为MB，默认为0，表示不受限制。

表1 data_images字段数据结构说明
参数	是否必选	参数类型	描述
name	是	String	数据盘镜像名称。
volume_id	是	String	数据盘ID。
description	否	String	数据盘描述。
tags	否	Array of strings	数据盘镜像标签。

使用上传至OBS桶中的外部镜像文件时的请求参数

参数	是否必选	参数类型	描述
name	是	String	镜像名称。name参数说明请参考镜像属性。
description	否	String	镜像描述信息。description参数说明请参考镜像属性。支持字母、数字、中文等，不支持回车、<、>，长度不能超过1024个字符。默认为空。
os_type	否	String	操作系统类型。取值为Linux、Windows、Other。
os_version	否	String	操作系统版本。使用上传至OBS桶中的外部镜像文件制作镜像时生效，具体取值见相关参数取值列表。说明：当“is_quick_import”的值为“true”时，即使用镜像文件快速导入方式导入系统盘镜像，则该参数为必填参数。
image_url	是	String	OBS桶中外部镜像文件地址。在使用OBS桶的外部镜像文件制作镜像时生效且为必选字段。格式为<OBS桶名>:<OBS镜像文件名称>。 “OBS桶名”获取方式：登录控制台，选择“存储 > 对象存储服务”。在下方OBS桶列表栏显示所有已创建的OBS桶。查看当前Region下，用于存放外部镜像文件的“桶名称”。 “OBS镜像文件名称”获取方式：登录控制台，选择“存储 > 对象存储服务”。在下方OBS桶列表栏显示所有已创建的OBS桶。查看当前Region下，用于存放外部镜像文件的“桶名称”。单击桶名称，进入对应OBS桶详情页。在左侧目录中选择“对象”，查看当前OBS桶中的对象，并记录用于制作镜像的外部镜像文件名称。说明：此处的OBS桶和镜像文件的存储类别必须是OBS标准存储。
min_disk	是	Integer	最小系统盘大小。在使用OBS桶的外部镜像文件制作镜像时生效且为必选字段。取值为1～1024GB。
is_config	否	Boolean	是否自动配置。取值为true或false。如果需要后台自动配置，取值为true，否则为false。默认取值为false。后台自动配置的内容请参考《镜像服务用户指南》中的“通过外部镜像文件创建Linux系统盘镜像 > 注册镜像（Linux）”。
cmk_id	否	String	创建加密镜像的自定义密钥，具体取值请参考《密钥管理服务用户指南》获取。
tags	否	Array of strings	镜像标签列表。默认为空。 tags和image_tags只能使用一个。
image_tags	否	Array of objects	新规范的镜像标签列表。默认为空。tags和image_tags只能使用一个。
max_ram	否	Integer	表示镜像支持的最大内存，单位为MB。
min_ram	否	Integer	表示镜像要求的最小内存，单位为MB，默认为0，表示不受限制。
data_images	否	Array of objects	需要导入的数据盘信息。外部镜像文件最多可携带3块数据盘，此时系统会创建1块系统盘、3块数据盘。详情请参见表2。说明：使用数据盘镜像文件创建数据盘镜像时，数据盘镜像的操作系统类型将和系统盘镜像保持一致。表2中的其他参数（如name、description、tags）如果有值，系统以data_images中的值为准。
is_quick_import	否	Boolean	是否使用镜像文件快速导入方式，导入系统盘镜像。是，配置为true。否，配置为false。关于镜像文件快速导入的约束与限制请参见镜像文件快速导入。

表2 data_images字段说明
参数	是否必选	参数类型	描述
name	否	String	镜像名称。 name参数说明请参见镜像属性。
description	否	String	镜像描述信息。默认为空。支持字母、数字、中文等，不支持回车、<、>，长度不能超过1024个字符。 description参数说明请参见镜像属性。
image_url	是	String	OBS桶中外部镜像文件地址。格式为“<OBS桶名>:<OBS镜像文件名称>”。 “OBS桶名”获取方式：登录控制台，选择“存储 > 对象存储服务”。在下方OBS桶列表栏显示所有已创建的OBS桶。查看当前Region下，用于存放外部镜像文件的“桶名称”。 “OBS镜像文件名称”获取方式：登录控制台，选择“存储 > 对象存储服务”。在下方OBS桶列表栏显示所有已创建的OBS桶。查看当前Region下，用于存放外部镜像文件的“桶名称”。单击桶名称，进入对应OBS桶详情页。在左侧目录中选择“对象”，查看当前OBS桶中的对象，并记录用于制作镜像的外部镜像文件名称。说明：此处的OBS桶和镜像文件的存储类别必须是OBS标准存储。
min_disk	是	Integer	最小数据盘大小。单位：GB 取值范围：1~2048GB
is_quick_import	否	Boolean	当前数据盘镜像是否使用镜像文件快速导入方式，创建数据盘镜像。是，配置为true。否，配置为false。关于镜像文件快速导入的约束与限制请参见镜像文件快速导入。
tags	否	Array of strings	镜像标签列表。默认为空。 tag的参数说明请参见镜像标签数据格式。 tags和image_tags只能使用一个。
image_tags	否	Array of objects	新规范的镜像标签列表。默认为空。 image_tags参数说明请参见镜像标签数据格式。 tags和image_tags只能使用一个。

请求示例

使用云服务器制作系统盘镜像，其中，镜像标签数据格式为tags，虚拟机ID为“877a2cda-ba63-4e1e-b95f-e67e48b6129a”。

POST https://{Endpoint}/v2/cloudimages/action
{
    "name": "ims_test",
    "description": "云服务器制作系统盘镜像",
    "instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
    "tags": [
        "aaa.111",
        "bbb.333",
        "ccc.444"
    ]
}

使用上传至OBS桶中的外部镜像文件制作镜像，其中，镜像标签数据格式为tags，OBS桶中外部镜像文件地址为“ims-image:centos70.qcow2”。

      
           POST https://{Endpoint}/v2/cloudimages/action
{
      "name": "ims_test_file",
      "description": "OBS文件制作镜像",
      "image_url": "ims-image:centos70.qcow2",
      "os_version": "CentOS 7.0 64bit",
      "min_disk": 40,
      "tags": [  
            "aaa.111",  
            "bbb.333",  
            "ccc.444"  
      ]     
}

使用云服务器制作系统盘镜像，其中，镜像标签数据格式为image_tags，虚拟机ID为“877a2cda-ba63-4e1e-b95f-e67e48b6129a”。

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"
        }
    ]
}

使用上传至OBS桶中的外部镜像文件制作镜像，其中，镜像标签数据格式为image_tags，OBS桶中外部镜像文件地址为“ims-image:centos70.qcow2”。

      
           POST https://{Endpoint}/v2/cloudimages/action
{
       "name": "ims_test_file",
       "description": "OBS文件制作镜像",
       "image_url": "ims-image:centos70.qcow2",
       "os_version": "CentOS 7.0 64bit",
       "min_disk": 40,
       "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]    
}

响应消息

响应参数

参数	参数类型	描述
job_id	String	异步任务ID。详情请参见异步任务查询。

参数

参数类型

描述

job_id

String

异步任务ID。

详情请参见异步任务查询。

响应样例

STATUS CODE 200

      
           {
    "job_id": "8a12fc664fb4daa3014fb4e581380005"
}

返回值

正常
 200

异常

返回值	说明
400 Bad Request	请求错误，具体返回错误码请参见错误码。
401 Unauthorized	鉴权失败。
403 Forbidden	没有操作权限。
404 Not Found	找不到资源。
500 Internal Server Error	服务内部错误。
503 Service Unavailable	服务不可用。

父主题： 镜像

上一篇：更新镜像信息

下一篇：镜像文件快速导入

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消