升级启动配置

最近更新时间:2019-07-24 14:49:54

1. 接口描述

接口请求域名: as.tencentcloudapi.com 。

本接口(UpgradeLaunchConfiguration)用于升级启动配置。

  • 本接口用于升级启动配置,采用“完全覆盖”风格,无论之前参数如何,统一按照接口参数设置为新的配置。对于非必填字段,不填写则按照默认值赋值。
  • 升级修改启动配置后,已经使用该启动配置扩容的存量实例不会发生变更,此后使用该启动配置的新增实例会按照新的配置进行扩容。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:as.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:UpgradeLaunchConfiguration
Version String 公共参数,本接口取值:2018-04-19
Region String 公共参数,详见产品支持的 地域列表
LaunchConfigurationId String 启动配置ID。
ImageId String 指定有效的镜像ID,格式形如img-8toqc6s3。镜像类型分为四种:
  • 公共镜像
  • 自定义镜像
  • 共享镜像
  • 服务市场镜像

  • 可通过以下方式获取可用的镜像ID:
  • 公共镜像自定义镜像共享镜像的镜像ID可通过登录控制台查询;服务镜像市场的镜像ID可通过云市场查询。
  • 通过调用接口 DescribeImages ,取返回信息中的ImageId字段。
  • InstanceTypes.N Array of String 实例机型列表,不同实例机型指定了不同的资源规格,最多支持5种实例机型。
    LaunchConfigurationName String 启动配置显示名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。
    DataDisks.N Array of DataDisk 实例数据盘配置信息。若不指定该参数,则默认不购买数据盘,最多支持指定11块数据盘。
    EnhancedService EnhancedService 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认开启云监控、云安全服务。
    InstanceChargeType String 实例计费类型,CVM默认值按照POSTPAID_BY_HOUR处理。

  • POSTPAID_BY_HOUR:按小时后付费

  • SPOTPAID:竞价付费
  • InstanceMarketOptions InstanceMarketOptionsRequest 实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。
    InstanceTypesCheckPolicy String 实例类型校验策略,取值包括 ALL 和 ANY,默认取值为ANY。

  • ALL,所有实例类型(InstanceType)都可用则通过校验,否则校验报错。

  • ANY,存在任何一个实例类型(InstanceType)可用则通过校验,否则校验报错。

    实例类型不可用的常见原因包括该实例类型售罄、对应云盘售罄等。
    如果 InstanceTypes 中一款机型不存在或者已下线,则无论 InstanceTypesCheckPolicy 采用何种取值,都会校验报错。
  • InternetAccessible InternetAccessible 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
    LoginSettings LoginSettings 实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码,并以站内信方式知会到用户。
    ProjectId Integer 实例所属项目ID。该参数可以通过调用 DescribeProject 的返回值中的projectId字段来获取。不填为默认项目。
    SecurityGroupIds.N Array of String 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的SecurityGroupId字段来获取。若不指定该参数,则默认不绑定安全组。
    SystemDisk SystemDisk 实例系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
    UserData String 经过 Base64 编码后的自定义数据,最大长度不超过16KB。
    InstanceTags.N Array of InstanceTag 标签列表。通过指定该参数,可以为扩容的实例绑定标签。最多支持指定10个标签。
    CamRoleName String CAM角色名称。可通过DescribeRoleList接口返回值中的roleName获取。

    3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 简单参数升级启动配置

    只传必传的启动配置名称,实例机型,镜像ID,其他均采用系统默认值,具体配置如下:启动配置名称为:as_test,实例机型为:标准2型 1C1G(S2.SMALL1),镜像ID为:img-8toqc6s3。

    输入示例

    https://as.tencentcloudapi.com/?Action=UpgradeLaunchConfiguration
    &LaunchConfigurationId=asc-gj14vczi
    &LaunchConfigurationName=as_test
    &InstanceTypes.0=S2.SMALL1
    &ImageId=img-8toqc6s3
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "d68a3364-a933-4664-bee4-fb89b8c69b49"
      }
    }

    示例2 详细参数升级启动配置

    启动配置名称为:as_test,镜像ID为:img-8toqc6s3,选择机型为:标准2型 1C1G(S2.SMALL1),系统盘选择 50G 本地硬盘,数据盘选择100G 普通云硬盘,公网付费模式为流量按小时后付费,外网带宽上限 5 Mbps,分配公网IP,选择密钥登录,安装云监控云安全。

    输入示例

    https://as.tencentcloudapi.com/?Action=UpgradeLaunchConfiguration
    &LaunchConfigurationId=asc-gj14vczi
    &LaunchConfigurationName=as_test
    &ImageId=img-8toqc6s3
    &InstanceTypes.0=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": {
        "RequestId": "1430a2d3-eb73-44c6-8316-218c4562a85c"
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

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

    错误码 描述
    CallCvmError CVM接口调用失败。
    InternalError 内部错误
    InvalidImageId.NotFound 未找到该镜像。
    InvalidParameter.Conflict 参数冲突,指定的多个参数冲突,不能同时存在。
    InvalidParameter.MustOneParameter 参数缺失,两种参数之中必须指定其中一个。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.CvmConfigurationError CVM参数校验异常。
    InvalidParameterValue.CvmError CVM参数校验异常。
    InvalidParameterValue.LaunchConfigurationNameDuplicated 启动配置名称重复。