更新时间:2023-07-17 GMT+08:00

云服务器创建镜像

功能介绍

弹性云服务器创建一个镜像,后续可以使用该镜像创建弹性云服务器

对于弹性云服务器创建的镜像,会以快照的形式放在存储节点。

该接口为社区原生接口,不适用云服务平台上创建镜像。

  • 如需创建系统盘镜像或数据盘镜像,请使用IMS接口:POST /v2/cloudimages/action,使用指导请参见《镜像服务接口参考》的“制作镜像”章节。
  • 如需创建整机镜像,请使用IMS接口:POST /v1/cloudimages/wholeimages/action,使用指导请参见《镜像服务接口参考》的“制作整机镜像”章节。

接口约束

  1. error状态的弹性云服务器无法用于创建镜像。
  2. 对于弹性云服务器创建的镜像,后续使用该镜像创建弹性云服务器时,只能创建在与原弹性云服务器相同的AZ内。
  3. 使用弹性云服务器创建的镜像被删除后,关联的快照不会自动删除(原生实现),需要用户自行删除。
  4. 使用弹性云服务器创建的镜像不支持用来创建数据盘。
  5. 使用本节提供的接口(URI:POST /v2/{project_id}/servers/{server_id}/action 或 POST /v2.1/{project_id}/servers/{server_id}/action)创建的镜像,不支持导出至OBS桶。如需支持导出OBS桶功能,请使用IMS接口:POST /v2/cloudimages/action,使用指导请参见《镜像服务接口参考》的“制作镜像”章节。

华为云不再提供Windows操作系统类型的镜像,该接口不支持指定Windows操作系统的弹性云服务器创建镜像。

URI

POST /v2.1/{project_id}/servers/{server_id}/action

参数说明请参见表1
表1 参数说明

参数

是否必选

描述

project_id

项目ID。

获取方法请参见获取项目ID

server_id

云服务器ID。

请求消息

请求参数如表2所示。

表2 请求参数

参数

是否必选

参数类型

描述

createImage

Object

云服务器导出镜像,参考表3

表3 createImage参数信息

参数

是否必选

参数类型

描述

name

String

镜像名称,长度大于0小于243字节

metadata

Object

镜像属性,属性名称的长度大于0小于255字节

响应消息

参数

是否必选

参数类型

描述

Location

String

镜像的本地url,在请求头中返回。

微版本2.44及以上版本不支持。

image_id

String

镜像UUID

微版本2.45及以上版本支持。

请求示例

使用指定弹性云服务器创建一个私有镜像,名称为“new-image-name”。

POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action

{
   "createImage" : {
        "name" : "new-image-name",
        "metadata": {
            "ImageType": "Gold",
            "ImageVersion": "2.0"
        }
    }
}

响应示例

返回值

请参考通用请求返回值