弹性伸缩
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>弹性伸缩>API 文档>启动配置相关接口>修改启动配置属性

修改启动配置属性

最近更新时间：2024-09-30 01:08:03

我的收藏

本页目录：

1. 接口描述

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

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

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

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

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

    • 示例值：img-8toqc6s3
    InstanceTypes.N 否 Array of String 实例类型列表，不同实例机型指定了不同的资源规格，最多支持10种实例机型。
    InstanceType 指定单一实例类型，通过设置 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.N 否 Array of String 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的SecurityGroupId字段来获取。
    若指定该参数，请至少提供一个安全组，列表顺序有先后。
    示例值：["sg-aaaabbbb"]
    InternetAccessible 否 InternetAccessible 公网带宽相关信息设置。
    当公网出带宽上限为0Mbps时，不支持修改为开通分配公网IP；相应的，当前为开通分配公网IP时，修改的公网出带宽上限值必须大于0Mbps。
    InstanceChargeType 否 String 实例计费类型。具体取值范围如下：
  • POSTPAID_BY_HOUR：按小时后付费
  • SPOTPAID：竞价付费
  • PREPAID：预付费，即包年包月

    • 示例值：POSTPAID_BY_HOUR
    InstanceChargePrepaid 否 InstanceChargePrepaid 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。
    若修改实例的付费模式为预付费，则该参数必传；从预付费修改为其他付费模式时，本字段原信息会自动丢弃。
    当新增该字段时，必须传递购买实例的时长，其它未传递字段会设置为默认值。
    当修改本字段时，当前付费模式必须为预付费。
    InstanceMarketOptions 否 InstanceMarketOptionsRequest 实例的市场相关选项，如竞价实例相关参数。
    若修改实例的付费模式为竞价付费，则该参数必传；从竞价付费修改为其他付费模式时，本字段原信息会自动丢弃。
    当新增该字段时，必须传递竞价相关选项下的竞价出价，其它未传递字段会设置为默认值。
    当修改本字段时，当前付费模式必须为竞价付费。
    DiskTypePolicy 否 String 云盘类型选择策略，取值范围：
  • ORIGINAL：使用设置的云盘类型。
  • AUTOMATIC：自动选择当前可用的云盘类型。

    • 示例值：ORIGINAL
    SystemDisk 否 SystemDisk 实例系统盘配置信息。
    DataDisks.N 否 Array of DataDisk 实例数据盘配置信息。
    最多支持指定11块数据盘。采取整体修改，因此请提供修改后的全部值。
    数据盘类型默认与系统盘类型保持一致。
    HostNameSettings 否 HostNameSettings 云服务器主机名（HostName）的相关设置。
    不支持windows实例设置主机名。
    新增该属性时，必须传递云服务器的主机名，其它未传递字段会设置为默认值。
    InstanceNameSettings 否 InstanceNameSettings 云服务器（InstanceName）实例名的相关设置。
    如果用户在启动配置中设置此字段，则伸缩组创建出的实例 InstanceName 参照此字段进行设置，并传递给 CVM；如果用户未在启动配置中设置此字段，则伸缩组创建出的实例 InstanceName 按照“as-{{ 伸缩组AutoScalingGroupName }}”进行设置，并传递给 CVM。
    新增该属性时，必须传递云服务器的实例名称，其它未传递字段会设置为默认值。
    EnhancedService 否 EnhancedService 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。
    CamRoleName 否 String CAM角色名称。可通过DescribeRoleList接口返回值中的roleName获取。
    示例值：TestRole
    HpcClusterId 否 String 高性能计算集群ID。

    注意：此字段默认为空。
    示例值：hpc-abcd1234
    IPv6InternetAccessible 否 IPv6InternetAccessible IPv6公网带宽相关信息设置。若新建实例包含IPv6地址，该参数可为新建实例的IPv6地址分配公网带宽。关联启动配置的伸缩组Ipv6AddressCount参数为0时，该参数不会生效。
    DisasterRecoverGroupIds.N 否 Array of String 置放群组id，仅支持指定一个。
    示例值：["ps-fy7e0ml0"]
    LoginSettings 否 LoginSettings 实例登录设置，包括密码、密钥或保持镜像的原始登录设置。
    请注意，指定新的登录设置会覆盖原有登录设置。例如，如果您之前使用密码登录，使用该参数将登录设置修改为密钥，则原有密码被清除。
    InstanceTags.N 否 Array of InstanceTag 实例标签列表。通过指定该参数，可以为扩容的实例绑定标签。最多支持指定10个标签。
    该参数会覆盖原有的实例标签列表，如需新增标签，需将新标签和原有标签一并传入。
    示例值：[{"Key":"Test","Value":"test"}]
    ImageFamily 否 String 镜像族名称。
    示例值：test-family

    3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 清空UserData

    指定启动配置asc-291kq6ku，将UserData修改为空字符串

    输入示例

    POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyLaunchConfigurationAttributes
<公共请求参数>

{
    "LaunchConfigurationId": "asc-291kq6ku",
    "UserData": ""
}

    输出示例

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

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

    指定启动配置asc-291kq6ku，修改镜像为img-8toqc6s3，修改实例类型为S2.SMALL1，修改启动配置名称为updated_config

    输入示例

    POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyLaunchConfigurationAttributes
<公共请求参数>

{
    "ImageId": "img-8toqc6s3",
    "InstanceTypes": [
        "S2.SMALL1"
    ],
    "LaunchConfigurationName": "updated_config",
    "LaunchConfigurationId": "asc-291kq6ku"
}

    输出示例

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

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError.CalleeError 调用其他服务异常。
    InvalidParameter.ActionNotFound 无效的Action请求。
    InvalidParameter.Conflict 参数冲突，指定的多个参数冲突，不能同时存在。
    InvalidParameter.HostNameUnavailable 主机名参数不适用于该镜像。
    InvalidParameter.InScenario 在特定场景下的不合法参数。
    InvalidParameter.InvalidCombination 无效的参数组合。
    InvalidParameter.ParameterDeprecated 该参数已废弃。
    InvalidParameter.ParameterMustBeDeleted 部分参数存在互斥应该删掉。
    InvalidParameterValue 参数取值错误。
    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.InvalidLaunchConfigurationId 启动配置ID无效。
    InvalidParameterValue.InvalidSecurityGroupId 安全组ID无效。
    InvalidParameterValue.LaunchConfigurationNameDuplicated 启动配置名称重复。
    InvalidParameterValue.LimitExceeded 取值超出限制。
    InvalidParameterValue.MissingBandwidthPackageId 当前账户在带宽包模式中必须填写带宽包ID参数。
    InvalidParameterValue.NotStringTypeFloat 提供的值不是浮点字符串格式。
    InvalidParameterValue.TooLong 取值过多。
    InvalidParameterValue.TooShort 输入参数值的长度小于最小值。
    InvalidParameterValue.UserDataFormatError UserData格式错误。
    InvalidParameterValue.UserDataSizeExceeded UserData长度过长。
    MissingParameter 缺少参数错误。
    MissingParameter.InScenario 在特定场景下缺少参数。
    ResourceNotFound.BandwidthPackageIdNotFound 指定的带宽包ID不存在。
    ResourceNotFound.DisasterRecoverGroupNotFound 指定的置放群组ID不存在。
    ResourceNotFound.LaunchConfigurationIdNotFound 指定的启动配置不存在。
    中国站
    文档反馈
    文档活动
    message-icon联系我们
    目录