创建启动配置
最近更新时间: 2026-09-17 00:04:45
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 | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| LaunchConfigurationName | 是 | 否 | String | 启动配置显示名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。 示例值: as_test |
| ProjectId | 否 | 否 | Uint64 | 实例所属项目ID。该参数可以通过调用 DescribeProjects 的返回值中的projectId字段来获取。不填为默认项目。示例值: 0 |
| InstanceType | 否 | 否 | String | 实例机型。不同实例机型指定了不同的资源规格,具体取值可通过调用接口 DescribeInstanceTypeConfigs 来获得最新的规格表或参见实例类型描述。InstanceType和InstanceTypes参数互斥,二者必填一个且只能填写一个。示例值: S2.SMALL1 |
| ImageId | 是 | 否 | String | 指定有效的[镜像]ID,格式形如img-8toqc6s3。镜像类型分为三种:可通过以下方式获取可用的镜像ID: 公共镜像、自定义镜像、共享镜像的镜像ID可通过登录[控制台]查询。ImageId字段。示例值: img-8toqc6s3 |
| SystemDisk | 否 | 否 | SystemDisk | 实例系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。 示例值:查看 |
| DataDisks | 否 | 否 | Array of DataDisk | 实例数据盘配置信息。若不指定该参数,则默认不购买数据盘,最多支持指定11块数据盘。 示例值:查看 |
| InternetAccessible | 否 | 否 | InternetAccessible | 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。 示例值:查看 |
| LoginSettings | 否 | 否 | LoginSettings | 实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码,并以站内信方式知会到用户。 示例值:查看 |
| SecurityGroupIds | 否 | 否 | Array of String | 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的SecurityGroupId字段来获取。若不指定该参数,则默认不绑定安全组。示例值: [] |
| EnhancedService | 否 | 否 | EnhancedService | 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认开启云监控、云安全服务。 示例值:查看 |
| UserData | 否 | 否 | String | 经过 Base64 编码后的自定义数据,最大长度不超过16KB。 示例值: TXlVc2VyRGF0YQo= |
| InstanceChargeType | 否 | 否 | String | 实例计费类型,CVM默认值按照POSTPAID_BY_HOUR处理。 示例值: POSTPAID_BY_HOUR |
| InstanceMarketOptions | 否 | 否 | InstanceMarketOptionsRequest | 实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。 示例值:查看 |
| InstanceTypes | 否 | 否 | Array of String | 实例机型列表,不同实例机型指定了不同的资源规格,最多支持10种实例机型。InstanceType和InstanceTypes参数互斥,二者必填一个且只能填写一个。示例值: ["S2.SMALL4", "S2.SMALL2"] |
| InstanceTypesCheckPolicy | 否 | 否 | String | 实例类型校验策略,取值包括 ALL 和 ANY,默认取值为ANY。 实例类型不可用的常见原因包括该实例类型售罄、对应云盘售罄等。 如果 InstanceTypes 中一款机型不存在或者已下线,则无论 InstanceTypesCheckPolicy 采用何种取值,都会校验报错。 示例值: ALL |
| InstanceTags | 否 | 否 | Array of InstanceTag | 标签列表。通过指定该参数,可以为扩容的实例绑定标签。最多支持指定10个标签。 示例值:查看 |
| CamRoleName | 否 | 否 | String | CAM角色名称。可通过DescribeRoleList接口返回值中的roleName获取。 示例值: roleName001 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| LaunchConfigurationId | String | 当通过本接口来创建启动配置时会返回该参数,表示启动配置ID。 示例值: asc-23h37kyn |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| AccountQualificationRestrictions | 该请求账户未通过资格审计。 |
| InvalidParameterValue.CvmConfigurationError | CVM参数校验异常。 |
| InvalidPermission | 账户不支持该操作。 |
| InvalidParameter.Conflict | 参数冲突,指定的多个参数冲突,不能同时存在。 |
| InvalidParameterValue.LaunchConfigurationNameDuplicated | 启动配置名称重复。 |
| InvalidParameter.MustOneParameter | 参数缺失,两种参数之中必须指定其中一个。 |
| LaunchConfigurationQuotaLimitExceeded | 启动配置配额超过限制。 |
| InvalidImageId.NotFound | 未找到该镜像。 |
| CallCvmError | CVM接口调用失败。 |
5. 示例
示例1 创建竞价实例配置
启动配置名称为:spot-test,机型为:标准2型 2C4G(S2.MEDIUM4),计费配置为竞价(SPOTPAID),最高出价为0.99元/小时。
输入示例
https://as.api3.fincloud.tencent.cn/?Action=CreateLaunchConfiguration
&LaunchConfigurationName=spot-test
&InstanceType=S2.MEDIUM4
&ImageId=img-8toqc6s3
&SystemDisk.DiskType=CLOUD_PREMIUM
&SystemDisk.DiskSize=50
&InternetAccessible.InternetChargeType=TRAFFIC_POSTPAID_BY_HOUR
&InternetAccessible.InternetMaxBandwidthOut=20
&InternetAccessible.PublicIpAssigned=true
&InstanceChargeType=SPOTPAID
&InstanceMarketOptions.MarketType=spot
&InstanceMarketOptions.SpotOptions.MaxPrice=0.99
&InstanceMarketOptions.SpotOptions.SpotInstanceType=one-time
&<公共请求参数>
输出示例
{
"Response": {
"LaunchConfigurationId": "asc-hpzwe3o2",
"RequestId": "ccfe3052-e9c9-47ee-bf3d-5bc2dfd972c0"
}
}
示例2 详细参数创建
启动配置名称为:as_test,镜像ID为:img-8toqc6s3,选择机型为:标准2型 1C1G(S2.SMALL1),系统盘选择 50G 本地硬盘,数据盘选择100G 普通云硬盘,公网付费模式为流量按小时后付费,外网带宽上限 5 Mbps,分配公网IP,选择密钥登录,安装云监控云安全。
输入示例
https://as.api3.fincloud.tencent.cn/?Action=CreateLaunchConfiguration
&LaunchConfigurationName=as_test
&ImageId=img-8toqc6s3
&InstanceType=S2.SMALL1
&SystemDisk.DiskType=LOCAL_BASIC
&SystemDisk.DiskSize=50
&DataDisks.0.DiskType=CLOUD_BASIC
&DataDisks.0.DiskSize=100
&InternetAccessible.InternetChargeType=TRAFFIC_POSTPAID_BY_HOUR
&InternetAccessible.InternetMaxBandwidthOut=5
&InternetAccessible.PublicIpAssigned=TRUE
&LoginSettings.KeyIds.0=skey-k8eypc1l
&EnhancedService.SecurityService.Enabled=TRUE
&EnhancedService.MonitorService.Enabled=TRUE
&<公共请求参数>
输出示例
{
"Response": {
"LaunchConfigurationId": "asc-fdz8j7dh",
"RequestId": "9a7209d3-2260-49d7-952a-dfa2001f8822"
}
}
示例3 创建启动配置,支持多种实例机型
支持两种实例机型,分别是S2.SMALL2和S2.SMALL4
输入示例
https://as.api3.fincloud.tencent.cn/?Action=CreateLaunchConfiguration
&LaunchConfigurationName=multi_instance_types
&InstanceTypes.0=S2.SMALL2
&InstanceTypes.1=S2.SMALL4
&ImageId=img-8toqc6s3
&<公共请求参数>
输出示例
{
"Response": {
"LaunchConfigurationId": "asc-77mh1cho",
"RequestId": "2864c860-27a0-439e-a1e1-0003b76734e7"
}
}
示例4 简单参数创建
只传必传的启动配置名称,实例机型,镜像ID,其他均采用系统默认值,具体配置如下:启动配置名称为:as_test,实例机型为:标准2型 1C1G(S2.SMALL1),镜像ID为:img-8toqc6s3。
输入示例
https://as.api3.fincloud.tencent.cn/?Action=CreateLaunchConfiguration
&LaunchConfigurationName=as_test
&InstanceType=S2.SMALL1
&ImageId=img-8toqc6s3
&<公共请求参数>
输出示例
{
"Response": {
"LaunchConfigurationId": "asc-23h37kyn",
"RequestId": "d639dd64-9e46-4246-b13c-80954f81c11b"
}
}