1. 接口描述
接口请求域名： lighthouse.tencentcloudapi.com 。
本接口(CreateInstances)用于创建一个或多个指定套餐的轻量应用服务器实例。
默认接口请求频率限制：5次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateInstances。 |
| Version | 是 | String | 公共参数，本接口取值：2020-03-24。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| BundleId | 是 | String | 套餐ID。可以通过调用 DescribeBundles 接口获取。 示例值：bundle_gen_03 |
| BlueprintId | 是 | String | 镜像ID。可以通过调用 DescribeBlueprints 接口获取。 示例值：lhbp-g0tn7djh |
| InstanceChargePrepaid | 是 | InstanceChargePrepaid | 当前实例仅支持预付费模式，即包年包月相关参数设置，单位（月）。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。该参数必传。 |
| InstanceName | 否 | String | 实例显示名称。 示例值：mylighthouse |
| InstanceCount | 否 | Integer | 购买实例数量。包年包月实例取值范围：[1，30]。默认取值：1。指定购买实例的数量不能超过用户所能购买的剩余配额数量 示例值：1 |
| Zones.N | 否 | Array of String | 可用区列表。 不填此参数，表示为随机可用区。 示例值：["ap-beijing-1"] |
| DryRun | 否 | Boolean | 是否只预检此次请求。 true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制和库存。 如果检查不通过，则返回对应错误码； 如果检查通过，则返回RequestId. false（默认）：发送正常请求，通过检查后直接创建实例 示例值：false |
| ClientToken | 否 | String | 用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。 示例值：test-create-instance-client-token |
| LoginConfiguration | 否 | LoginConfiguration | 实例登录密码信息配置。默认缺失情况下代表用户选择实例创建后设置登录密码。 |
| Containers.N | 否 | Array of DockerContainerConfiguration | 要创建的容器配置列表。 |
| AutoVoucher | 否 | Boolean | 是否自动使用代金券。默认不使用。 示例值：false |
| FirewallTemplateId | 否 | String | 防火墙模板ID。若不指定该参数，则使用默认防火墙策略。 示例值：lhft-abcd1234 |
| Tags.N | 否 | Array of Tag | 标签键和标签值。 如果指定多个标签，则会为指定资源同时创建并绑定该多个标签。 同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键，则对应的标签值会更新为新值。 如果标签不存在会为您自动创建标签。 数组最多支持10个元素。 |
| InitCommand | 否 | Command | 创建实例后自动执行的命令。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceIdSet | Array of String | 当通过本接口来创建实例时会返回该参数，表示一个或多个实例ID。返回实例ID列表并不代表实例创建成功。 可根据 DescribeInstances 接口查询返回的InstancesSet中对应实例的ID的状态来判断创建是否完成；如果实例状态由“启动中”变为“运行中”，则为创建成功。 示例值：["lhins-abcd1234"] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 通过API创建轻量应用服务器
用户可以通过调用此接口，创建预付费的轻量应用服务器。
输入示例
POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateInstances
<公共请求参数>
{
"BundleId": "bundle_gen_03",
"BlueprintId": "lhbp-g0tn7djh",
"InstanceChargePrepaid": {
"Period": "1",
"RenewFlag": "NOTIFY_AND_MANUAL_RENEW"
}
}输出示例
{
"Response": {
"InstanceIdSet": [
"lhins-hx5wjw4g"
],
"RequestId": "232b2817-ec08-43f3-8d78-41b1bfb6082c"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.InvalidRegion | 该地域尚未开放，请选择其他地域。 |
| FailedOperation | 操作失败。 |
| FailedOperation.CreateInstancesFailed | 创建实例失败。 |
| FailedOperation.InsufficientBalance | 账户余额不足, 请及时充值。 |
| FailedOperation.UnableToCreateInstances | 无法创建实例。 |
| InternalError | 内部错误。 |
| InternalError.InvalidActionNotFound | 无法找到此接口。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.BundleAndBlueprintNotMatch | 套餐和镜像不匹配。 |
| InvalidParameter.BundleIdNotFound | 产品未定义的套餐 ID。 |
| InvalidParameterValue.BlueprintId | 镜像 ID 不合法，重装实例不允许切换操作系统类型。 |
| InvalidParameterValue.BlueprintIdMalformed | 参数值非法，镜像 ID 格式非法。 |
| InvalidParameterValue.BundleAndBlueprintNotMatch | 套餐和镜像不匹配。 |
| InvalidParameterValue.BundleNotSupportBlueprintPlatform | 所选套餐不支持镜像的操作系统平台类型。 |
| InvalidParameterValue.ClientTokenTooLong | 客户令牌长度超出限制。 |
| InvalidParameterValue.FirewallTemplateIdMalformed | 防火墙模板ID格式非法。 |
| InvalidParameterValue.InstanceNameTooLong | 参数值非法，实例名称超过允许的最大长度。 |
| InvalidParameterValue.InvalidBlueprintId | 镜像 ID 不合法。 |
| InvalidParameterValue.InvalidBundle | 非法的套餐参数。 |
| InvalidParameterValue.InvalidBundleBlueprintCombination | 套餐和镜像的组合非法。 |
| InvalidParameterValue.InvalidParameterCombination | 参数组合非法。 |
| InvalidParameterValue.InvalidPassword | 参数中的密码不合法。 |
| InvalidParameterValue.InvalidZone | 参数Zone的取值不合法。 |
| InvalidParameterValue.KeyPairIdMalformed | 参数值非法，密钥对 ID 格式非法。 |
| InvalidParameterValue.OutOfRange | 参数值非法，不在合法范围内。 |
| InvalidParameterValue.ZoneInvalid | 非法的可用区。 |
| LimitExceeded | 超过配额限制。 |
| LimitExceeded.InstanceQuotaLimitExceeded | 超过实例配额。 |
| ResourceNotFound.BlueprintIdNotFound | 镜像 ID 不存在。 |
| ResourceNotFound.BlueprintNotFound | 指定的镜像不存在。请检查镜像的BlueprintId是否正确。 |
| ResourceNotFound.FirewallTemplateNotFound | 防火墙模板不存在 |
| ResourceNotFound.KeyPairNotFound | 密钥对不存在。 |
| ResourceUnavailable.BundleUnavailable | 套餐不可用。 |
| ResourceUnavailable.InvalidPurchaseRequestSource | 当前套餐不支持通过API购买。 |
| ResourcesSoldOut.BundleSoldOut | 套餐已售罄。 |
| ResourcesSoldOut.PurchaseSourceHasNoBundleConfigs | 套餐无可用配置。 |
| ResourcesSoldOut.ZonesHasNoBundleConfigs | 套餐无可用配置。 |
| UnauthorizedOperation.NoPermission | 无权限。 |
| UnsupportedOperation.InstanceLinuxUnixCreatingNotSupportPassword | LinuxUnix实例在创建时不支持设置密码。 |
