1. 接口描述
此接口处于预下线状态 。
预计下线时间:2023-11-22 14:30:38
接口请求域名: as.tencentcloudapi.com 。
已有替代接口ModifyLaunchConfiguration。该接口存在覆盖参数风险,目前官网已隐藏
本接口(UpgradeLaunchConfiguration)用于升级启动配置。
- 本接口用于升级启动配置,采用“完全覆盖”风格,无论之前参数如何,统一按照接口参数设置为新的配置。对于非必填字段,不填写则按照默认值赋值。
- 升级修改启动配置后,已经使用该启动配置扩容的存量实例不会发生变更,此后使用该启动配置的新增实例会按照新的配置进行扩容。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:UpgradeLaunchConfiguration。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
LaunchConfigurationId | 是 | String | 启动配置ID。 示例值:asc-aaaabbbb |
ImageId | 是 | String | 指定有效的镜像ID,格式形如img-8toqc6s3 。镜像类型分为四种:可通过以下方式获取可用的镜像ID: 公共镜像 、自定义镜像 、共享镜像 的镜像ID可通过登录控制台查询;服务镜像市场 的镜像ID可通过云市场查询。ImageId 字段。示例值:img-aaaabbbb |
InstanceTypes.N | 是 | Array of String | 实例机型列表,不同实例机型指定了不同的资源规格,最多支持5种实例机型。 示例值:["S5.SMALL2"] |
LaunchConfigurationName | 是 | String | 启动配置显示名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。 示例值:myascname |
DataDisks.N | 否 | Array of DataDisk | 实例数据盘配置信息。若不指定该参数,则默认不购买数据盘,最多支持指定11块数据盘。 |
EnhancedService | 否 | EnhancedService | 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认开启云监控、云安全服务。 |
InstanceChargeType | 否 | String | 实例计费类型,CVM默认值按照POSTPAID_BY_HOUR处理。 示例值:POSTPAID_BY_HOUR |
InstanceMarketOptions | 否 | InstanceMarketOptionsRequest | 实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。 |
InstanceTypesCheckPolicy | 否 | String | 实例类型校验策略,取值包括 ALL 和 ANY,默认取值为ANY。 实例类型不可用的常见原因包括该实例类型售罄、对应云盘售罄等。 如果 InstanceTypes 中一款机型不存在或者已下线,则无论 InstanceTypesCheckPolicy 采用何种取值,都会校验报错。 示例值:ALL |
InternetAccessible | 否 | InternetAccessible | 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。 |
LoginSettings | 否 | LoginSettings | 该参数已失效,请勿使用。升级启动配置接口无法修改或覆盖 LoginSettings 参数,升级后 LoginSettings 不会发生变化。 |
ProjectId | 否 | Integer | 实例所属项目ID。不填为默认项目。 示例值:1222 |
SecurityGroupIds.N | 否 | Array of String | 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的SecurityGroupId 字段来获取。若不指定该参数,则默认不绑定安全组。示例值:["sg-aaaabbbb"] |
SystemDisk | 否 | SystemDisk | 实例系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。 |
UserData | 否 | String | 经过 Base64 编码后的自定义数据,最大长度不超过16KB。 示例值:"" |
InstanceTags.N | 否 | Array of InstanceTag | 标签列表。通过指定该参数,可以为扩容的实例绑定标签。最多支持指定10个标签。 |
CamRoleName | 否 | String | CAM角色名称。可通过DescribeRoleList接口返回值中的roleName获取。 示例值:myrolename |
HostNameSettings | 否 | HostNameSettings | 云服务器主机名(HostName)的相关设置。 |
InstanceNameSettings | 否 | InstanceNameSettings | 云服务器实例名(InstanceName)的相关设置。 |
InstanceChargePrepaid | 否 | InstanceChargePrepaid | 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。 |
DiskTypePolicy | 否 | String | 云盘类型选择策略,取值范围: |
IPv6InternetAccessible | 否 | IPv6InternetAccessible | IPv6公网带宽相关信息设置。若新建实例包含IPv6地址,该参数可为新建实例的IPv6地址分配公网带宽。关联启动配置的伸缩组Ipv6AddressCount参数为0时,该参数不会生效。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
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: UpgradeLaunchConfiguration
<公共请求参数>
{
"ImageId": "img-8toqc6s3",
"LaunchConfigurationName": "as_test",
"InstanceTypes": [
"S2.SMALL1"
],
"LaunchConfigurationId": "asc-gj14vczi"
}
输出示例
{
"Response": {
"RequestId": "d68a3364-a933-4664-bee4-fb89b8c69b49"
}
}
示例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: UpgradeLaunchConfiguration
<公共请求参数>
{
"SystemDisk": {
"DiskSize": "50",
"DiskType": "LOCAL_BASIC"
},
"LoginSettings": {
"KeyIds": [
"skey-k8eypc1l"
]
},
"LaunchConfigurationId": "asc-gj14vczi",
"InstanceTypes": [
"S2.SMALL1"
],
"ImageId": "img-8toqc6s3",
"EnhancedService": {
"SecurityService": {
"Enabled": "TRUE"
},
"MonitorService": {
"Enabled": "TRUE"
}
},
"LaunchConfigurationName": "as_test",
"InternetAccessible": {
"PublicIpAssigned": "TRUE",
"InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
"InternetMaxBandwidthOut": "5"
},
"DataDisks": [
{
"Encrypt": "FALSE",
"DeleteWithInstance": "TRUE",
"DiskSize": "1000",
"ThroughputPerformance": "100",
"DiskType": "CLOUD_HSSD"
}
]
}
输出示例
{
"Response": {
"RequestId": "1430a2d3-eb73-44c6-8316-218c4562a85c"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
CallCvmError | CVM接口调用失败。 |
InternalError | 内部错误。 |
InvalidImageId.NotFound | 未找到该镜像。 |
InvalidParameter.ActionNotFound | 无效的Action请求。 |
InvalidParameter.Conflict | 参数冲突,指定的多个参数冲突,不能同时存在。 |
InvalidParameter.InvalidCombination | 无效的参数组合。 |
InvalidParameter.MustOneParameter | 参数缺失,两种参数之中必须指定其中一个。 |
InvalidParameter.ParameterDeprecated | 该参数已废弃。 |
InvalidParameter.ParameterMustBeDeleted | 部分参数存在互斥应该删掉。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.AccountNotSupportBandwidthPackageId | 当前账户不支持带宽包ID参数。 |
InvalidParameterValue.CvmConfigurationError | CVM参数校验异常。 |
InvalidParameterValue.CvmError | CVM参数校验异常。 |
InvalidParameterValue.HostNameIllegal | 主机名不合法。 |
InvalidParameterValue.IPv6InternetChargeType | 指定的IPv6公网带宽计费模式不合法。 |
InvalidParameterValue.InstanceTypeNotSupported | 实例机型不支持。 |
InvalidParameterValue.InvalidImageId | 镜像ID无效。 |
InvalidParameterValue.InvalidInstanceType | 实例机型无效。 |
InvalidParameterValue.InvalidLaunchConfigurationId | 启动配置ID无效。 |
InvalidParameterValue.LaunchConfigurationNameDuplicated | 启动配置名称重复。 |
InvalidParameterValue.MissingBandwidthPackageId | 当前账户在带宽包模式中必须填写带宽包ID参数。 |
InvalidParameterValue.NotStringTypeFloat | 提供的值不是浮点字符串格式。 |
InvalidParameterValue.ProjectIdNotFound | 项目ID不存在。 |
InvalidParameterValue.Range | 取值超出指定范围。 |
InvalidParameterValue.UserDataFormatError | UserData格式错误。 |
InvalidParameterValue.UserDataSizeExceeded | UserData长度过长。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound.BandwidthPackageIdNotFound | 指定的带宽包ID不存在。 |
ResourceNotFound.LaunchConfigurationIdNotFound | 指定的启动配置不存在。 |