创建镜像

最近更新时间:2020-10-28 08:02:56

1. 接口描述

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

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

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateImage。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
ImageName String 镜像名称
InstanceId String 需要制作镜像的实例ID。
ImageDescription String 镜像描述
ForcePoweroff String 是否执行强制关机以制作镜像。
取值范围:
  • TRUE:表示关机之后制作镜像
  • FALSE:表示开机状态制作镜像

    默认取值:FALSE。

    开机状态制作镜像,可能导致部分数据未备份,影响数据安全。
  • Sysprep String 创建Windows镜像时是否启用Sysprep,关于Sysprep的详情请参考链接
    DataDiskIds.N Array of String 基于实例创建整机镜像时,指定包含在镜像里的数据盘Id
    SnapshotIds.N Array of String 基于快照创建镜像,指定快照ID,必须包含一个系统盘快照。不可与InstanceId同时传入。
    DryRun Boolean 检测本次请求的是否成功,但不会对操作的资源产生任何影响

    3. 输出参数

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

    4. 示例

    示例1 创建一个镜像

    使用实例ins-6pb6lrmy 创建一个镜像。当实例处于运行中时,执行软关机,软关机失败后,结束任务(默认语义)。

    输入示例

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

    输出示例

    {
      "Response": {
        "ImageId": "img-0yc6rie8",
        "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.DataDiskIdContainsRootDisk DataDiskIds不应该传入RootDisk的Id。
    InvalidParameter.DataDiskNotBelongSpecifiedInstance 指定的数据盘不属于指定的实例。
    InvalidParameter.DuplicateSystemSnapshots 只能包含一个系统盘快照。
    InvalidParameter.InstanceImageNotSupport 当前接口不支持实例镜像。
    InvalidParameter.InvalidDependence 参数依赖不正确。
    InvalidParameter.LocalDataDiskNotSupport 本地盘不支持创建实例镜像。
    InvalidParameter.SnapshotNotFound 指定的快照不存在。
    InvalidParameter.SpecifyOneParameter 多选一必选参数缺失。
    InvalidParameter.SwapDiskNotSupport 不支持Swap盘。
    InvalidParameter.SystemSnapshotNotFound 参数不包含系统盘快照。
    InvalidParameter.ValueTooLarge 参数长度超过限制。
    InvalidParameterConflict 指定的两个参数冲突,不能同时存在。 EIP只能绑定在实例上或指定网卡的指定内网 IP 上。
    InvalidParameterValue.TooLarge 参数值超过最大限制。
    MutexOperation.TaskRunning 同样的任务正在运行。
    OperationDenied.InstanceOperationInProgress 实例正在执行其他操作,请稍后再试。
    ResourceInsufficient.CloudDiskUnavailable 云盘参数不符合规范
    UnsupportedOperation.InstanceStateRebooting 请求不支持正在重启的实例
    UnsupportedOperation.InstanceStateStopping 请求不支持正在关机的实例
    UnsupportedOperation.InstanceStateTerminating 请求不支持正在销毁的实例
    UnsupportedOperation.NotSupportInstanceImage 操作不支持当前实例
    UnsupportedOperation.StoppedModeStopCharging 不支持关机不收费特性
    目录