创建镜像

最近更新时间:2018-11-15 19:13:41

查看pdf

1. 接口描述

接口请求域名: cvm.tencentcloudapi.com 。

本接口(CreateImage)用于将实例的系统盘制作为新镜像,创建后的镜像可以用于创建实例。

默认接口请求频率限制:10次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cvm.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateImage
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
InstanceId String 需要制作镜像的实例ID
ImageName String 镜像名称
ImageDescription String 镜像描述
ForcePoweroff String 软关机失败时是否执行强制关机以制作镜像
Sysprep String 创建Windows镜像时是否启用Sysprep
Reboot String 实例处于运行中时,是否允许关机执行制作镜像任务。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建一个镜像

输入示例

https://cvm.tencentcloudapi.com/?Action=CreateImage
&InstanceId=ins-6pb6lrmy
&ImageName="name"
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
ImageQuotaLimitExceeded 镜像配额超过了限制。
InvalidImageName.Duplicate 镜像名称与原有镜像重复。
InvalidInstance.NotSupported 不被支持的实例。
InvalidInstanceId.NotFound 没有找到相应实例。
InvalidParameter.ValueTooLarge 参数长度超过限制。
MutexOperation.TaskRunning 同样的任务正在运行。