有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

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

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

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

2. 输入参数

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

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

    默认取值:false。

    开机状态制作镜像,可能导致部分数据未备份,影响数据安全。
    示例值:true
  • Sysprep String 创建Windows镜像时是否启用Sysprep。
    取值范围:true或false,传true表示启用Sysprep,传false表示不启用,默认取值为false。

    关于Sysprep的详情请参考链接
    示例值:false
    DataDiskIds.N Array of String 基于实例创建整机镜像时,指定包含在镜像里的数据盘ID
    示例值:["disk-6gabakqz"]
    SnapshotIds.N Array of String 基于快照创建镜像,指定快照ID,必须包含一个系统盘快照。不可与InstanceId同时传入。
    示例值:["snap-kso6f712", "snap-l3rrf322"]
    DryRun Boolean 检测本次请求的是否成功,但不会对操作的资源产生任何影响。默认取值为false。
    示例值:false
    TagSpecification.N Array of TagSpecification 标签描述列表。通过指定该参数可以同时绑定标签到自定义镜像。

    3. 输出参数

    参数名称 类型 描述
    ImageId String 镜像ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:img-2v3sqe2t
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 创建一个镜像

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

    输入示例

    POST / HTTP/1.1
    Host: cvm.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateImage
    <公共请求参数>
    
    {
        "InstanceId": "ins-6pb6lrmy",
        "ImageName": "myImage"
    }

    输出示例

    {
        "Response": {
            "ImageId": "img-0yc6rie8",
            "RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    ImageQuotaLimitExceeded 镜像配额超过了限制。
    InvalidAccount.InsufficientBalance 账户余额不足。
    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.InvalidAppIdFormat 无效的appid。
    InvalidParameterValue.LimitExceeded 参数值数量超过限制。
    InvalidParameterValue.PreheatNotSupportedInstanceType 该机型不支持预热
    InvalidParameterValue.PreheatNotSupportedZone 该可用区目前不支持预热功能
    InvalidParameterValue.PreheatUnavailableZones 预热地域不可用,请检查预热地域是否正确。
    InvalidParameterValue.TagKeyNotFound 指定的标签不存在。
    InvalidParameterValue.TagQuotaLimitExceeded 标签配额超限。
    InvalidParameterValue.TooLarge 参数值超过最大限制。
    InvalidZone.MismatchRegion 指定的zone不存在。
    LimitExceeded.PreheatImageSnapshotOutOfQuota 您在该可用区的预热额度已达上限,建议取消不再使用的快照预热
    MutexOperation.TaskRunning 同样的任务正在运行。
    OperationDenied.InstanceOperationInProgress 实例正在执行其他操作,请稍后再试。
    ResourceInUse 资源被占用。
    ResourceInUse.DiskRollbacking 磁盘回滚正在执行中,请稍后再试。
    ResourceInsufficient.CloudDiskUnavailable 云盘参数不符合规范
    ResourceUnavailable.SnapshotCreating 快照正在创建过程中。
    UnsupportedOperation.EncryptedImagesNotSupported 不支持加密镜像。
    UnsupportedOperation.InstanceReinstallFailed 当前实例为重装系统失败状态,不支持此操作;推荐您再次重装系统,也可以销毁/退还实例或提交工单
    UnsupportedOperation.InstanceStateEnterRescueMode 请求不支持进入救援模式的实例
    UnsupportedOperation.InstanceStateEnterServiceLiveMigrate 不支持状态为 ENTER_SERVICE_LIVE_MIGRATE.的实例 ins-xxxxxx
    UnsupportedOperation.InstanceStateExitRescueMode 请求不支持正在退出救援模式的实例
    UnsupportedOperation.InstanceStateFreezing 操作不支持已冻结的实例。
    UnsupportedOperation.InstanceStateRebooting 请求不支持正在重启的实例
    UnsupportedOperation.InstanceStateRescueMode 请求不支持救援模式的实例
    UnsupportedOperation.InstanceStateServiceLiveMigrate 不支持正在服务迁移的实例,请稍后再试
    UnsupportedOperation.InstanceStateStarting 实例开机中,不允许该操作。
    UnsupportedOperation.InstanceStateStopping 请求不支持正在关机的实例
    UnsupportedOperation.InstanceStateTerminating 请求不支持正在销毁的实例
    UnsupportedOperation.InvalidDiskFastRollback 不支持极速回滚。
    UnsupportedOperation.NotSupportInstanceImage 操作不支持当前实例
    UnsupportedOperation.PreheatImage 您的账户不支持镜像预热
    UnsupportedOperation.SpecialInstanceType 请求不支持特殊机型的实例
    UnsupportedOperation.StoppedModeStopCharging 不支持关机不收费特性