1. 接口描述
接口请求域名： lighthouse.tencentcloudapi.com 。
本接口 (CreateBlueprint) 用于创建镜像。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateBlueprint。 |
| Version | 是 | String | 公共参数，本接口取值：2020-03-24。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| BlueprintName | 是 | String | 镜像名称。最大长度60。 示例值：test-blueprint |
| Description | 否 | String | 镜像描述。最大长度60。 示例值：test-blueprint |
| InstanceId | 否 | String | 需要制作镜像的实例ID。 示例值：lhins-aaaabbbb |
| ForcePowerOff | 否 | Boolean | 是否执行强制关机以制作镜像。 取值范围： True：表示关机之后制作镜像 False：表示开机状态制作镜像 默认取值：True 开机状态制作镜像，可能导致部分数据未备份，影响数据安全。 示例值：True |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| BlueprintId | String | 自定义镜像ID。 示例值：lhbp-xkeh87da |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 使用实例创建镜像
使用实例创建镜像
输入示例
POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBlueprint
<公共请求参数>
{
"BlueprintName": "test-blueprint",
"InstanceId": "lhins-7ugtz5e1"
}输出示例
{
"Response": {
"BlueprintId": "lhbp-xkeh87da",
"RequestId": "6bdba9db-c3fe-45b2-87f3-b0125d901a90"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.CreateBlueprintFailed | 创建镜像失败。 |
| FailedOperation.InsufficientBalance | 账户余额不足, 请及时充值。 |
| FailedOperation.UnableToCreateBlueprint | 操作失败，不能创建自定义镜像。 |
| InternalError | 内部错误。 |
| InternalError.DescribeInstanceStatus | 查询实例状态失败，请稍后重试。 |
| InvalidParameterValue.InstanceIdMalformed | 参数值非法，实例 ID 格式非法。 |
| InvalidParameterValue.TooLong | 参数取值过长，超过最大长度。 |
| LimitExceeded.BlueprintQuotaLimitExceeded | 配额不足，当前自定义镜像配额不允许创建新的自定义镜像。 |
| ResourceNotFound.InstanceIdNotFound | 实例 ID 不存在。 |
| UnauthorizedOperation.NoPermission | 无权限。 |
| UnsupportedOperation.InstanceDisplayAreaNotSupportOperation | 实例展示区域不支持该操作。 |
| UnsupportedOperation.InvalidInstanceState | 不支持的操作，实例状态不合法。 |
| UnsupportedOperation.LatestOperationUnfinished | 不支持的操作，实例最近一次的操作尚未完成。 |
