1. 接口描述
接口请求域名: as.tencentcloudapi.com 。
本接口(CreateLaunchConfiguration)用于创建新的启动配置。
启动配置,可以通过
ModifyLaunchConfigurationAttributes
修改少量字段。如需使用新的启动配置,建议重新创建启动配置。每个项目最多只能创建20个启动配置,详见使用限制。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateLaunchConfiguration。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
LaunchConfigurationName | 是 | String | 启动配置显示名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。 示例值:as_test |
ImageId | 否 | String | 指定有效的镜像ID,格式形如img-8toqc6s3 。镜像Id与镜像族名称,二者必填一个且只能填写一个。镜像类型分为四种:可通过以下方式获取可用的镜像ID: 公共镜像 、自定义镜像 、共享镜像 的镜像ID可通过登录控制台查询;服务镜像市场 的镜像ID可通过云市场查询。ImageId 字段。示例值:img-8toqc6s3 |
ProjectId | 否 | Integer | 启动配置所属项目ID。不填为默认项目。 注意:伸缩组内实例所属项目ID取伸缩组项目ID,与这里取值无关。 示例值:0 |
InstanceType | 否 | String | 实例机型。不同实例机型指定了不同的资源规格,具体取值可通过调用接口 DescribeInstanceTypeConfigs 来获得最新的规格表或参见实例类型描述。InstanceType 和InstanceTypes 参数互斥,二者必填一个且只能填写一个。示例值:S2.SMALL1 |
SystemDisk | 否 | SystemDisk | 实例系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。 示例值:{"DiskSize": 500, "DiskType": "CLOUD_BSSD"} |
DataDisks.N | 否 | Array of DataDisk | 实例数据盘配置信息。若不指定该参数,则默认不购买数据盘,最多支持指定11块数据盘。 示例值:[{"DiskSize": 200, "DiskType": "CLOUD_BSSD"}] |
InternetAccessible | 否 | InternetAccessible | 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。 示例值:{"InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR", "InternetMaxBandwidthOut": 0, "PublicIpAssigned": false} |
LoginSettings | 否 | LoginSettings | 实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码,并以站内信方式知会到用户。 示例值:{"KeyIds": ["skey-alaz9k65"]} |
SecurityGroupIds.N | 否 | Array of String | 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的SecurityGroupId 字段来获取。若不指定该参数,则默认不绑定安全组。示例值:["sg-arrfspxo"] |
EnhancedService | 否 | EnhancedService | 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认开启云监控、云安全服务。 示例值:{"MonitorService": {"Enabled": true}, "SecurityService": {"Enabled": true}} |
UserData | 否 | String | 经过 Base64 编码后的自定义数据,最大长度不超过16KB。 示例值:IyEvYmluL2Jhc2gKZWNobyAxMjMKCg== |
InstanceChargeType | 否 | String | 实例计费类型,CVM默认值按照POSTPAID_BY_HOUR处理。 示例值:POSTPAID_BY_HOUR |
InstanceMarketOptions | 否 | InstanceMarketOptionsRequest | 实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。 示例值:{"SpotOptions": {"MaxPrice": 1000}} |
InstanceTypes.N | 否 | Array of String | 实例机型列表,不同实例机型指定了不同的资源规格,最多支持10种实例机型。InstanceType 和InstanceTypes 参数互斥,二者必填一个且只能填写一个。示例值:["S5.MEDIUM2", "S6.MEDIUM2"] |
CamRoleName | 否 | String | CAM角色名称。可通过DescribeRoleList接口返回值中的roleName获取。 示例值:CVM_QcsRole |
InstanceTypesCheckPolicy | 否 | String | 实例类型校验策略,取值包括 ALL 和 ANY,默认取值为ANY。 实例类型不可用的常见原因包括该实例类型售罄、对应云盘售罄等。 如果 InstanceTypes 中一款机型不存在或者已下线,则无论 InstanceTypesCheckPolicy 采用何种取值,都会校验报错。 示例值:ANY |
InstanceTags.N | 否 | Array of InstanceTag | 标签列表。通过指定该参数,可以为扩容的实例绑定标签。最多支持指定10个标签。 示例值:[{"Key": "server-group-name", "Value": "as-tencent"}] |
Tags.N | 否 | Array of Tag | 标签描述列表。通过指定该参数可以支持绑定标签到启动配置。每个启动配置最多支持30个标签。 示例值:[{"Key": "CCode", "Value": "ASTENCENT", "ResourceType": "launch-configuration"}] |
HostNameSettings | 否 | HostNameSettings | 云服务器主机名(HostName)的相关设置。 示例值:{"HostName": "app-as", "HostNameStyle": "UNIQUE"} |
InstanceNameSettings | 否 | InstanceNameSettings | 云服务器实例名(InstanceName)的相关设置。 如果用户在启动配置中设置此字段,则伸缩组创建出的实例 InstanceName 参照此字段进行设置,并传递给 CVM;如果用户未在启动配置中设置此字段,则伸缩组创建出的实例 InstanceName 按照“as-{{ 伸缩组AutoScalingGroupName }}”进行设置,并传递给 CVM。 示例值:{"InstanceName": "app-as", "InstanceNameStyle": "UNIQUE"} |
InstanceChargePrepaid | 否 | InstanceChargePrepaid | 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。 示例值:{"Period": 1, "RenewFlag": "NOTIFY_AND_AUTO_RENEW"} |
DiskTypePolicy | 否 | String | 云盘类型选择策略,默认取值 ORIGINAL,取值范围: 示例值:ORIGINAL |
HpcClusterId | 否 | String | 高性能计算集群ID。 注意:此字段默认为空。 示例值:hpc-gt4es2q1 |
IPv6InternetAccessible | 否 | IPv6InternetAccessible | IPv6公网带宽相关信息设置。若新建实例包含IPv6地址,该参数可为新建实例的IPv6地址分配公网带宽。关联启动配置的伸缩组Ipv6AddressCount参数为0时,该参数不会生效。 示例值:{"InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR", "InternetMaxBandwidthOut": 1} |
DisasterRecoverGroupIds.N | 否 | Array of String | 置放群组id,仅支持指定一个。 示例值:["ps-dy7ui89o"] |
ImageFamily | 否 | String | 镜像族名称。镜像Id与镜像族名称,二者必填一个且只能填写一个。 示例值:test-family |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
LaunchConfigurationId | String | 当通过本接口来创建启动配置时会返回该参数,表示启动配置ID。 示例值:asc-23h37kyn |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 简单参数创建
只传必传的启动配置名称,实例机型,镜像ID,其他均采用系统默认值,具体配置如下:启动配置名称为:as_test,实例机型为:标准2型 1C1G(S2.SMALL1),镜像ID为:img-8toqc6s3。
输入示例
POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLaunchConfiguration
<公共请求参数>
{
"ImageId": "img-8toqc6s3",
"InstanceType": "S2.SMALL1",
"LaunchConfigurationName": "as_test"
}
输出示例
{
"Response": {
"LaunchConfigurationId": "asc-23h37kyn",
"RequestId": "d639dd64-9e46-4246-b13c-80954f81c11b"
}
}
示例2 详细参数创建
启动配置名称为:as_test,镜像ID为:img-8toqc6s3,选择机型为:标准2型 1C1G(S2.SMALL1),系统盘选择 50G 本地硬盘,数据盘选择100G 普通云硬盘,实例销毁时不保留数据盘,数据盘不加密,公网付费模式为流量按小时后付费,外网带宽上限 5 Mbps,分配公网IP,选择密钥登录,安装云监控云安全。
输入示例
POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLaunchConfiguration
<公共请求参数>
{
"SystemDisk": {
"DiskSize": "50",
"DiskType": "LOCAL_BASIC"
},
"LoginSettings": {
"KeyIds": [
"skey-k8eypc1l"
]
},
"ImageId": "img-8toqc6s3",
"EnhancedService": {
"SecurityService": {
"Enabled": "TRUE"
},
"MonitorService": {
"Enabled": "TRUE"
}
},
"LaunchConfigurationName": "as_test",
"InternetAccessible": {
"PublicIpAssigned": "TRUE",
"InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
"InternetMaxBandwidthOut": "5"
},
"InstanceType": "S2.SMALL1",
"DataDisks": [
{
"Encrypt": "FALSE",
"DeleteWithInstance": "TRUE",
"DiskSize": "100",
"DiskType": "CLOUD_BASIC"
}
]
}
输出示例
{
"Response": {
"LaunchConfigurationId": "asc-fdz8j7dh",
"RequestId": "9a7209d3-2260-49d7-952a-dfa2001f8822"
}
}
示例3 创建竞价实例配置
启动配置名称为:spot-test,机型为:标准2型 2C4G(S2.MEDIUM4),计费配置为竞价(SPOTPAID),最高出价为0.99元/小时。
输入示例
POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLaunchConfiguration
<公共请求参数>
{
"SystemDisk": {
"DiskSize": "50",
"DiskType": "CLOUD_PREMIUM"
},
"InstanceMarketOptions": {
"SpotOptions": {
"SpotInstanceType": "one-time",
"MaxPrice": "0.99"
},
"MarketType": "spot"
},
"ImageId": "img-8toqc6s3",
"InstanceChargeType": "SPOTPAID",
"LaunchConfigurationName": "spot-test",
"InternetAccessible": {
"PublicIpAssigned": "true",
"InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
"InternetMaxBandwidthOut": "20"
},
"InstanceType": "S2.MEDIUM4"
}
输出示例
{
"Response": {
"LaunchConfigurationId": "asc-hpzwe3o2",
"RequestId": "ccfe3052-e9c9-47ee-bf3d-5bc2dfd972c0"
}
}
示例4 创建启动配置,支持多种实例机型
支持两种实例机型,分别是S2.SMALL2和S2.SMALL4
输入示例
POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLaunchConfiguration
<公共请求参数>
{
"ImageId": "img-8toqc6s3",
"InstanceTypes": [
"S2.SMALL4",
"S2.SMALL2"
],
"LaunchConfigurationName": "multi_instance_types"
}
输出示例
{
"Response": {
"LaunchConfigurationId": "asc-77mh1cho",
"RequestId": "2864c860-27a0-439e-a1e1-0003b76734e7"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.CallStsError | STS 接口调用失败。 |
InternalError.CalleeError | 调用其他服务异常。 |
InvalidParameter.ActionNotFound | 无效的Action请求。 |
InvalidParameter.Conflict | 参数冲突,指定的多个参数冲突,不能同时存在。 |
InvalidParameter.HostNameUnavailable | 主机名参数不适用于该镜像。 |
InvalidParameter.InvalidCombination | 无效的参数组合。 |
InvalidParameter.MustOneParameter | 参数缺失,两种参数之中必须指定其中一个。 |
InvalidParameter.ParameterDeprecated | 该参数已废弃。 |
InvalidParameter.ParameterMustBeDeleted | 部分参数存在互斥应该删掉。 |
InvalidParameterValue.AccountNotSupportBandwidthPackageId | 当前账户不支持带宽包ID参数。 |
InvalidParameterValue.CvmConfigurationError | CVM参数校验异常。 |
InvalidParameterValue.HostNameIllegal | 主机名不合法。 |
InvalidParameterValue.HostNameWithSuffixTooLong | 带后缀的主机名称过长,超过了规定上限。 |
InvalidParameterValue.IPv6InternetChargeType | 指定的IPv6公网带宽计费模式不合法。 |
InvalidParameterValue.ImageNotFound | 指定的镜像不存在。 |
InvalidParameterValue.InstanceNameIllegal | 设置的实例名称不合法。 |
InvalidParameterValue.InstanceNameWithSuffixTooLong | 带后缀的实例名称过长,超过了规定上限。 |
InvalidParameterValue.InstanceTypeNotSupported | 实例机型不支持。 |
InvalidParameterValue.InvalidDisasterRecoverGroupId | 指定的置放群组ID格式不正确。 |
InvalidParameterValue.InvalidHpcClusterId | 高性能计算集群ID无效。 |
InvalidParameterValue.InvalidImageId | 镜像ID无效。 |
InvalidParameterValue.InvalidInstanceType | 实例机型无效。 |
InvalidParameterValue.InvalidLaunchConfiguration | 输入的启动配置无效。 |
InvalidParameterValue.InvalidSecurityGroupId | 安全组ID无效。 |
InvalidParameterValue.InvalidSnapshotId | 快照ID无效。 |
InvalidParameterValue.LaunchConfigurationNameDuplicated | 启动配置名称重复。 |
InvalidParameterValue.LimitExceeded | 取值超出限制。 |
InvalidParameterValue.MissingBandwidthPackageId | 当前账户在带宽包模式中必须填写带宽包ID参数。 |
InvalidParameterValue.NotStringTypeFloat | 提供的值不是浮点字符串格式。 |
InvalidParameterValue.ProjectIdNotFound | 项目ID不存在。 |
InvalidParameterValue.TooLong | 取值过多。 |
InvalidParameterValue.TooShort | 输入参数值的长度小于最小值。 |
InvalidParameterValue.UserDataFormatError | UserData格式错误。 |
InvalidParameterValue.UserDataSizeExceeded | UserData长度过长。 |
InvalidPermission | 账户不支持该操作。 |
LimitExceeded.LaunchConfigurationQuotaNotEnough | 启动配置配额不足。 |
MissingParameter | 缺少参数错误。 |
MissingParameter.InstanceMarketOptions | 竞价计费类型缺少对应的 InstanceMarketOptions 参数。 |
ResourceNotFound.BandwidthPackageIdNotFound | 指定的带宽包ID不存在。 |
ResourceNotFound.DisasterRecoverGroupNotFound | 指定的置放群组ID不存在。 |
UnauthorizedOperation.AutoScalingRoleUnauthorized | 未授权弹性伸缩预设服务角色AS_QCSRole,请前往弹性伸缩控制台进行授权。 |