修改启动配置属性

最近更新时间:2019-05-30 20:03:04

1. 接口描述

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

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyLaunchConfigurationAttributes
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种实例机型。
    启动配置,通过 InstanceType 表示单一实例类型,通过 InstanceTypes 表示多实例类型。指定 InstanceTypes 成功启动配置后,原有的 InstanceType 自动失效。
    InstanceTypesCheckPolicy String 实例类型校验策略,在实际修改 InstanceTypes 时发挥作用,取值包括 ALL 和 ANY,默认取值为ANY。

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

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

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

    3. 输出参数

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

    4. 示例

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

    输入示例

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

    输出示例

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

    示例2 清空UserData

    输入示例

    https://as.tencentcloudapi.com/?Action=ModifyLaunchConfigurationAttributes
    &LaunchConfigurationId=asc-291kq6ku
    &UserData=
    &<公共请求参数>

    输出示例

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

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

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

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