CreateImage

1. 接口描述

本接口(CreateImage)用于创建自定义镜像。

注意事项

  • 每个区域最多只支持创建5个自定义镜像,当该地区达到最大限额时,将无法继续创建自定义镜像,如有特殊需求可联系Support增加上限。

  • 制作镜像会拷贝实例的系统盘,创建时请确保实例处于关机状态,不要对实例进行任何操作。

  • 创建出的镜像大小与实例的系统盘大小相同。

  • 目前SIN-ELAX-A地区暂不支持该操作。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称必选类型描述

instanceId

String

需要制作镜像的实例ID。

imageName

String

镜像名称。 镜像名称必须符合以下规则:

  • 长度不超过24位

  • 支持中文、字母、数字或连接符号 -_.

imageDescription

String

镜像描述。 不超过255个字符。

3. 响应结果

参数名称类型描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 requestId。

imageId

String

镜像ID。

4. 代码示例

  1. 创建一个镜像。

POST /api/v2/vm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: CreateImage
<Common Request Params>

Request:
{
  "instanceId": "your-instance-id",
  "imageName": "testimagename",
  "imageDescription": "testimagedescription"
}

Response:
{
  "requestId": "T69E37B61-4E39-4461-A2BB-205F847D1D60",
  "response": {
    "requestId": "T69E37B61-4E39-4461-A2BB-205F847D1D60",
    "imageId": "img-xxxxx"
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集(SDK),未来会陆续支持更多开发语言,方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码,其他错误码见公共错误码

HTTP状态码错误码说明

404

INVALID_INSTANCE_NOT_FOUND

指定实例不存在。

400

UNSUPPORTED_OPERATION_INSTANCE_STATE_STARTING

实例开机中,不支持该操作。

400

LIMIT_EXCEEDED_IMAGE_QUOTA

镜像配额超出限制。

400

UNSUPPORTED_OPERATION_ZONE_NOT_SUPPORT

所在区域不支持该操作。

400

UNSUPPORTED_OPERATION_DISK_UNAVAILABLE

实例的云硬盘状态不可用。

400

UNSUPPORTED_OPERATION_DISK_MAKING_IMAGE

实例的云硬盘正在制作镜像。

最后更新于