创建镜像

最近更新时间:2024-03-12 01:29:04

我的收藏

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateImage。
Version String 公共参数,本接口取值:2019-07-19。
Region String 公共参数,本接口不需要传递此参数。
ImageName String 镜像名称。
InstanceId String 需要制作镜像的实例ID。
ImageDescription String 镜像描述。
ForcePoweroff String 是否执行强制关机以制作镜像。取值范围:
TRUE:表示自动关机后制作镜像
FALSE:表示开机状态制作,目前不支持,需要先手动关机
默认取值:FALSE。

3. 输出参数

参数名称 类型 描述
TaskId String 任务id
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建镜像

输入示例

https://ecm.tencentcloudapi.com/?Action=CreateImage
&InstanceId=ein-93sjjr8k
&ImageName=test_name
&ImageDescription=test_description
&ForcePoweroff=TRUE
&<公共请求参数>

输出示例

{
    "Response": {
        "TaskId": "1528611",
        "RequestId": "a3c3e99e-c4d7-11ea-ba2d-52540002f896"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.InstanceNotAllStopped 实例没有全部关机。
FailedOperation.InternalOperationFailure 内部操作错误。
InvalidParameter 参数错误。
InvalidParameter.InvalidDataFormat 数据格式不正确。
InvalidParameterValue.ImageNameDuplicate 镜像名称重复。
InvalidParameterValue.InvalidInstanceID 实例ID不合法。
MissingParameter 缺少参数错误。
MissingParameter.MissingImageParameter 镜像操作参数不全。
ResourceInsufficient.InvaildPrivateImageNum 私有镜像数量超出限制。
UnauthorizedOperation.ForbiddenOperation 没有权限进行该操作。
UnsupportedOperation 操作不支持。
UnsupportedOperation.InstanceIdNotFound 无效实例ID。指定的实例ID不存在。
UnsupportedOperation.InstanceIdNotSupported 不被支持的实例。
UnsupportedOperation.InvalidInstanceState 当前状态不能进行该操作。