修改启动配置属性

最近更新时间: 2026-11-07 00:12:51

1. 接口描述

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

本接口(ModifyLaunchConfigurationAttributes)用于修改启动配置部分属性。

  • 修改启动配置后,已经使用该启动配置扩容的存量实例不会发生变更,此后使用该启动配置的新增实例会按照新的配置进行扩容。
  • 本接口支持修改部分简单类型。

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

接口更新时间:2022-11-04 17:56:13。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数,本接口取值:ModifyLaunchConfigurationAttributes
Version 是 否 String 公共参数,本接口取值:2018-04-19
Region 是 否 String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
LaunchConfigurationId 是 否 String 启动配置ID
示例值: asc-aaaabbbb
ImageId 否 否 String 指定有效的镜像ID,格式形如img-8toqc6s3。镜像类型分为四种:
  • 公共镜像
  • 自定义镜像
  • 共享镜像
  • 服务市场镜像

  • 可通过以下方式获取可用的镜像ID:
  • 公共镜像、自定义镜像、共享镜像的镜像ID可通过登录控制台查询。
  • 通过调用接口 DescribeImages ,取返回信息中的ImageId字段。

  • 示例值: img-8toqc6s3
    InstanceTypes 否 否 Array of String 实例类型列表,不同实例机型指定了不同的资源规格,最多支持5种实例机型。
    启动配置,通过 InstanceType 表示单一实例类型,通过 InstanceTypes 表示多实例类型。指定 InstanceTypes 成功启动配置后,原有的 InstanceType 自动失效。
    示例值: S5.SMALL2
    InstanceTypesCheckPolicy 否 否 String 实例类型校验策略,在实际修改 InstanceTypes 时发挥作用,取值包括 ALL 和 ANY,默认取值为ANY。

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

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

    实例类型不可用的常见原因包括该实例类型售罄、对应云盘售罄等。
    如果 InstanceTypes 中一款机型不存在或者已下线,则无论 InstanceTypesCheckPolicy 采用何种取值,都会校验报错。
    示例值: ALL
  • LaunchConfigurationName 否 否 String 启动配置显示名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。
    示例值: myascname
    UserData 否 否 String 经过 Base64 编码后的自定义数据,最大长度不超过16KB。如果要清空UserData,则指定其为空字符串
    示例值: ""
    SecurityGroupIds 否 是 Array of String

    实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的SecurityGroupId字段来获取。
    若指定该参数,请至少提供一个安全组,列表顺序有先后。


    示例值: ["sg-aaaabbbb"]
    Metadata 否 是 Metadata

    自定义metadata。


    示例值:查看
    CamRoleName 否 是 String

    CAM角色名称。可通过DescribeRoleList接口返回值中的roleName获取。


    示例值: TestRole
    InstanceChargeType 否 是 String

    实例计费类型。具体取值范围如下:

  • POSTPAID_BY_HOUR:按小时后付费
  • SPOTPAID:竞价付费
  • PREPAID:预付费,即包年包月
  • CDCPAID:专用集群付费

  • 示例值: POSTPAID_BY_HOUR
    DataDisks 否 是 Array of DataDisk

    实例数据盘配置信息。
    最多支持指定11块数据盘。采取整体修改,因此请提供修改后的全部值。
    数据盘类型默认与系统盘类型保持一致。


    示例值:查看
    IPv6InternetAccessible 否 是 IPv6InternetAccessible

    IPv6公网带宽相关信息设置。若新建实例包含IPv6地址,该参数可为新建实例的IPv6地址分配公网带宽。关联启动配置的伸缩组Ipv6AddressCount参数为0时,该参数不会生效。


    示例值:查看
    InstanceTags 否 是 Array of InstanceTag

    实例标签列表。通过指定该参数,可以为扩容的实例绑定标签。最多支持指定10个标签。
    该参数会覆盖原有的实例标签列表,如需新增标签,需将新标签和原有标签一并传入。


    示例值:查看
    InstanceNameSettings 否 是 InstanceNameSettings

    云服务器(InstanceName)实例名的相关设置。
    如果用户在启动配置中设置此字段,则伸缩组创建出的实例 InstanceName 参照此字段进行设置,并传递给 CVM;如果用户未在启动配置中设置此字段,则伸缩组创建出的实例 InstanceName 按照“as-{{ 伸缩组AutoScalingGroupName }}”进行设置,并传递给 CVM。
    新增该属性时,必须传递云服务器的实例名称,其它未传递字段会设置为默认值。
    会校验实例名(如果存在后缀则加上后缀)是否超过最大位数108。


    示例值:查看
    DisasterRecoverGroupIds 否 是 Array of String

    置放群组id,仅支持指定一个。可通过调用DescribeDisasterRecoverGroups接口获取该参数。


    示例值: ["ps-fy7e0ml0"]
    LoginSettings 否 是 LoginSettings

    实例登录设置,包括密码、密钥或保持镜像的原始登录设置。
    请注意,指定新的登录设置会覆盖原有登录设置。例如,如果您之前使用密码登录,使用该参数将登录设置修改为密钥,则原有密码被清除。


    示例值:查看
    ImageFamily 否 是 String

    镜像族名称。可通过调用DescribeImages接口获取该参数。


    示例值: test-family
    DedicatedClusterId 否 是 String

    本地专用集群ID。


    示例值: cluster-gbo27yc4
    InternetAccessible 否 是 InternetAccessible

    公网带宽相关信息设置。
    当公网出带宽上限为0Mbps时,不支持修改为开通分配公网IP;相应的,当前为开通分配公网IP时,修改的公网出带宽上限值必须大于0Mbps。


    示例值:查看
    InstanceChargePrepaid 否 是 InstanceChargePrepaid

    预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。
    若修改实例的付费模式为预付费,则该参数必传;从预付费修改为其他付费模式时,本字段原信息会自动丢弃。
    当新增该字段时,必须传递购买实例的时长,其它未传递字段会设置为默认值。
    当修改本字段时,当前付费模式必须为预付费。


    示例值:查看
    SystemDisk 否 是 SystemDisk

    实例系统盘配置信息。


    示例值:查看
    EnhancedService 否 是 EnhancedService

    增强服务。通过该参数可以指定是否开启云安全、云监控等服务。


    示例值:查看
    DisableHyperThreading 否 是 Bool

    是否关闭超线程。
    true:扩容实例时关闭超线程。
    false(默认):扩容实例时不关闭超线程。


    示例值: false
    DiskTypePolicy 否 是 String

    云盘类型选择策略,取值范围:

  • ORIGINAL:使用设置的云盘类型。
  • AUTOMATIC:自动选择当前可用的云盘类型。

  • 示例值: ORIGINAL
    HostNameSettings 否 是 HostNameSettings

    云服务器主机名(HostName)的相关设置。
    不支持windows实例设置主机名。
    新增该属性时,必须传递云服务器的主机名,其它未传递字段会设置为默认值。
    会校验主机名(如果存在后缀则加上后缀)是否超过最大位数46。


    示例值:查看
    InstanceMarketOptions 否 是 InstanceMarketOptionsRequest

    实例的市场相关选项,如竞价实例相关参数。
    若修改实例的付费模式为竞价付费,则该参数必传;从竞价付费修改为其他付费模式时,本字段原信息会自动丢弃。
    当新增该字段时,必须传递竞价相关选项下的竞价出价,其它未传递字段会设置为默认值。
    当修改本字段时,当前付费模式必须为竞价付费。


    示例值:查看
    HpcClusterId 否 是 String

    高性能计算集群ID。可通过调用DescribeHpcClusters接口获取该参数。
    注意:此字段默认为空。


    示例值: hpc-acbd1324

    3. 输出参数

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

    4. 错误码

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

    错误码 描述
    AccountQualificationRestrictions 该请求账户未通过资格审计。
    InvalidParameterValue.LaunchConfigurationNameDuplicated 启动配置名称重复。
    InvalidParameterValue.CvmConfigurationError CVM参数校验异常。
    InvalidImageId.NotFound 未找到该镜像。
    CallCvmError CVM接口调用失败。
    InvalidParameterValue.InstanceTypeNotSupported 实例类型不支持

    5. 示例

    示例1 清空UserData

    输入示例

    https://as.api3.fincloud.tencent.cn/?Action=ModifyLaunchConfigurationAttributes
    &LaunchConfigurationId=asc-291kq6ku
    &UserData=
    &<Common Parameters>
    

    输出示例

    {
        "Response": {
            "RequestId": "2c027f22-3a3b-489a-a77a-89c53fc15212"
        }
    }
    

    示例2 指定启动配置,修改镜像、实例类型、名称

    输入示例

    https://as.api3.fincloud.tencent.cn/?Action=ModifyLaunchConfigurationAttributes
    &LaunchConfigurationId=asc-291kq6ku
    &ImageId=img-8toqc6s3
    &InstanceTypes.0=S2.SMALL1
    &LaunchConfigurationName=updated_config
    &<Common Parameters>
    

    输出示例

    {
        "Response": {
            "RequestId": "07022dcb-5bba-48f0-a2b0-800ad006d031"
        }
    }