创建启动配置

最近更新时间: 2024-06-18 14:31:18

1. 接口描述

接口请求域名: as.api3.fincloud.tencent.cn。

本接口(CreateLaunchConfiguration)用于创建新的启动配置。

  • 启动配置,可以通过 ModifyLaunchConfigurationAttributes 修改少量字段。如需使用新的启动配置,建议重新创建启动配置。

  • 每个项目最多只能创建20个启动配置,详见使用限制

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

接口更新时间:2021-04-28 10:32:54。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:CreateLaunchConfiguration
Version String 公共参数,本接口取值:2018-04-19
Region String 公共参数,详见产品支持的地域列表(TODO)
LaunchConfigurationName String 启动配置显示名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。
ProjectId Uint64 实例所属项目ID。该参数可以通过调用 DescribeProjects 的返回值中的projectId字段来获取。不填为默认项目。
InstanceType String 实例机型。不同实例机型指定了不同的资源规格,具体取值可通过调用接口 DescribeInstanceTypeConfigs 来获得最新的规格表或参见实例类型描述。<br>InstanceTypeInstanceTypes参数互斥,二者必填一个且只能填写一个。
ImageId String 指定有效的[镜像]ID,格式形如img-8toqc6s3。镜像类型分为三种:<br/><li>公共镜像</li><li>自定义镜像</li><li>共享镜像</li><br/>可通过以下方式获取可用的镜像ID:<br/><li>公共镜像自定义镜像共享镜像的镜像ID可通过登录[控制台]查询。</li><li>通过调用接口 [DescribeImages],取返回信息中的ImageId字段。</li>
SystemDisk SystemDisk 实例系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
DataDisks Array of DataDisk 实例数据盘配置信息。若不指定该参数,则默认不购买数据盘,最多支持指定11块数据盘。
InternetAccessible InternetAccessible 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
LoginSettings LoginSettings 实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码,并以站内信方式知会到用户。
SecurityGroupIds Array of String 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的SecurityGroupId字段来获取。若不指定该参数,则默认不绑定安全组。
EnhancedService EnhancedService 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认开启云监控、云安全服务。
UserData String 经过 Base64 编码后的自定义数据,最大长度不超过16KB。
InstanceChargeType String 实例计费类型,CVM默认值按照POSTPAID_BY_HOUR处理。<br><br><li>POSTPAID_BY_HOUR:按小时后付费<br><br><li>SPOTPAID:竞价付费
InstanceMarketOptions InstanceMarketOptionsRequest 实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。
InstanceTypes Array of String 实例机型列表,不同实例机型指定了不同的资源规格,最多支持10种实例机型。<br>InstanceTypeInstanceTypes参数互斥,二者必填一个且只能填写一个。
InstanceTypesCheckPolicy String 实例类型校验策略,取值包括 ALL 和 ANY,默认取值为ANY。<br><br><li> ALL,所有实例类型(InstanceType)都可用则通过校验,否则校验报错。<br><br><li> ANY,存在任何一个实例类型(InstanceType)可用则通过校验,否则校验报错。<br><br>实例类型不可用的常见原因包括该实例类型售罄、对应云盘售罄等。<br>如果 InstanceTypes 中一款机型不存在或者已下线,则无论 InstanceTypesCheckPolicy 采用何种取值,都会校验报错。
InstanceTags Array of InstanceTag 标签列表。通过指定该参数,可以为扩容的实例绑定标签。最多支持指定10个标签。
CamRoleName String CAM角色名称。可通过DescribeRoleList接口返回值中的roleName获取。

3. 输出参数

参数名称 类型 描述
LaunchConfigurationId String 当通过本接口来创建启动配置时会返回该参数,表示启动配置ID。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
AccountQualificationRestrictions
InvalidParameterValue.CvmConfigurationError
InvalidPermission
InvalidParameter.Conflict
InvalidParameterValue.LaunchConfigurationNameDuplicated
InvalidParameter.MustOneParameter
LaunchConfigurationQuotaLimitExceeded
InvalidImageId.NotFound
CallCvmError