创建实例启动模板
最近更新时间: 2024-06-18 14:31:29
1. 接口描述
接口请求域名： cvm.api3.fincloud.tencent.cn。
本接口（CreateLaunchTemplate）用于创建实例启动模板。
实例启动模板是一种配置数据并可用于创建实例，其内容包含创建实例所需的配置，比如实例类型，数据盘和系统盘的类型和大小，以及安全组等信息。
默认接口请求频率限制：20次/秒。
接口更新时间：2023-03-17 15:13:24。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateLaunchTemplate |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| LaunchTemplateName | 否 | 否 | String | 实例启动模板名称。长度为2~128个英文或中文字符。 |
| Placement | 是 | 否 | Placement | 实例所在的位置。通过该参数可以指定实例所属可用区，所属项目，所属宿主机（在专用宿主机上创建子机时指定）等属性。 |
| ImageId | 是 | 否 | String | 指定有效的镜像ID，格式形如img-xxx。镜像类型分为四种：：<br><li>公共镜像<br><li>自定义镜像<br><li>共享镜像<br><li>服务市场镜像<br>公共镜像、自定义镜像、共享镜像的镜像ID可通过登录控制台查询；服务镜像市场的镜像ID可通过云市场查询。通过调用接口 DescribeImages ，传入InstanceType获取当前机型支持的镜像列表，取返回信息中的ImageId字段。 |
| LaunchTemplateVersionDescription | 否 | 否 | String | 实例启动模板版本描述。长度为2~256个英文或中文字符。 |
| InstanceType | 是 | 否 | String | 实例机型。不同实例机型指定了不同的资源规格。 |
| SystemDisk | 否 | 否 | SystemDisk | 实例系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。 |
| DataDisks | 否 | 否 | Array of DataDisk | Array of DataDisk 实例数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。 |
| VirtualPrivateCloud | 否 | 否 | VirtualPrivateCloud | 私有网络相关信息配置。通过该参数可以指定私有网络的ID，子网ID等信息。若不指定该参数，则默认使用基础网络。若在此参数中指定了私有网络IP，即表示每个实例的主网卡IP；同时，InstanceCount参数必须与私有网络IP的个数一致且不能大于20。 |
| InternetAccessible | 否 | 否 | InternetAccessible | 公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。 |
| InstanceCount | 否 | 否 | Int64 | 购买实例数量。包年包月实例取值范围：[1，300]，按量计费实例取值范围：[1，100]。默认取值：1。指定购买实例的数量不能超过用户所能购买的剩余配额数量，具体配额相关限制详见CVM实例购买限制。 |
| InstanceName | 否 | 否 | String | 实例显示名称。 |
| LoginSettings | 否 | 否 | LoginSettings | 实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码，并以站内信方式知会到用户。 |
| SecurityGroupIds | 否 | 否 | Array of String | 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数，则绑定默认安全组。 |
| EnhancedService | 否 | 否 | EnhancedService | 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数，则默认公共镜像开启云监控、云安全服务；自定义镜像与镜像市场镜像默认不开启云监控，云安全服务，而使用镜像里保留的服务。 |
| ClientToken | 否 | 否 | String | 用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。 |
| HostName | 否 | 否 | String | 云服务器的主机名<br><li>点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。<br><li>Windows 实例：名字符长度为[2, 15]，允许字母（不限制大小写）、数字和短横线（-）组成，不支持点号（.），不能全是数字。<br><li>其他类型（Linux 等）实例：字符长度为[2, 60]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。 |
| ActionTimer | 否 | 否 | Datetime | 定时任务。通过该参数可以为实例指定定时任务，目前仅支持定时销毁。 |
| DisasterRecoverGroupIds | 否 | 否 | Array of String | 置放群组id，仅支持指定一个。 |
| TagSpecification | 否 | 否 | Array of TagSpecification | 标签描述列表。通过指定该参数可以同时绑定标签到相应的资源实例，当前仅支持绑定标签到云服务器实例。 |
| UserData | 否 | 否 | String | 提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16KB。 |
| CamRoleName | 否 | 否 | String | CAM角色名称。可通过DescribeRoleList接口返回值中的roleName获取。 |
| HpcClusterId | 否 | 否 | String | 高性能计算集群ID。若创建的实例为高性能计算实例，需指定实例放置的集群，否则不可指定。 |
| InstanceChargeType | 否 | 否 | String | 实例计费类型。 |
| InstanceChargePrepaid | 否 | 否 | InstanceChargePrepaid | 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。 |
| DisableApiTermination | 否 | 否 | Bool | 实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：<br><li>TRUE：表示开启实例保护，不允许通过api接口删除实例<br><li>FALSE：表示关闭实例保护，允许通过api接口删除实例<br>默认取值：FALSE。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| LaunchTemplateId | String | 当通过本接口来创建实例启动模板时会返回该参数，表示创建成功的实例启动模板ID。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| AccountQualificationRestrictions | |
| FailedOperation.DisasterRecoverGroupNotFound | |
| FailedOperation.InquiryPriceFailed | |
| FailedOperation.NoAvailableIpAddressCountInSubnet | |
| FailedOperation.SnapshotSizeLargerThanDataSize | |
| InternalError | |
| InvalidParameterValueLimit | |
| InvalidParameterCombination | |
| InvalidParameter.ValueTooLarge | |
| VpcAddrNotInSubNet | |
| InvalidInstanceType.Malformed | |
| InvalidClientToken.TooLong | |
| InvalidImageOsType.Unsupported | |
| InvalidParameter.InvalidIpFormat | |
| ImageQuotaLimitExceeded | |
| InvalidCloudDisk.SoldOut | |
| SecGroupActionFailure | |
| FailedOperation.NoAvailableInstanceType |