当前位置:主页 > 查看内容

弹性伸缩 修改启动配置属性 - API 文档

发布时间:2021-09-12 00:00| 位朋友查看

简介:1. 接口描述 接口请求域名: as.tencentcloudapi.com 。 本接口(ModifyLaunchConfigurationAttributes)用于修改启动配置部分属性。 修改启动配置后,已经使用该启动配置扩容的存量实例不会发生变更,此后使用该启动配置的新增实例会按照新的配置进行扩容。……

1. 接口描述

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

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

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

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

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

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

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 实例类型列表,不同实例机型指定了不同的资源规格,最多支持10种实例机型。
    启动配置,通过 InstanceType 表示单一实例类型,通过 InstanceTypes 表示多实例类型。指定 InstanceTypes 成功启动配置后,原有的 InstanceType 自动失效。
    InstanceTypesCheckPolicy String 实例类型校验策略,在实际修改 InstanceTypes 时发挥作用,取值包括 ALL 和 ANY,默认取值为ANY。

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

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

    实例类型不可用的常见原因包括该实例类型售罄、对应云盘售罄等。
    如果 InstanceTypes 中一款机型不存在或者已下线,则无论 InstanceTypesCheckPolicy 采用何种取值,都会校验报错。
  • LaunchConfigurationName String 启动配置显示名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。
    UserData String 经过 Base64 编码后的自定义数据,最大长度不超过16KB。如果要清空UserData,则指定其为空字符串
    SecurityGroupIds.N Array of String 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的SecurityGroupId字段来获取。
    若指定该参数,请至少提供一个安全组,列表顺序有先后。
    InternetAccessible InternetAccessible 公网带宽相关信息设置。
    本字段属复杂类型,修改时采取整字段全覆盖模式。即只修改复杂类型内部一个子字段时,也请提供全部所需子字段。
    InstanceChargeType String 实例计费类型。具体取值范围如下:

  • POSTPAID_BY_HOUR:按小时后付费

  • SPOTPAID:竞价付费

  • PREPAID:预付费,即包年包月
  • InstanceChargePrepaid InstanceChargePrepaid 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。
    若修改实例的付费模式为预付费,则该参数必传;从预付费修改为其他付费模式时,本字段原信息会自动丢弃。
    本字段属复杂类型,修改时采取整字段全覆盖模式。即只修改复杂类型内部一个子字段时,也请提供全部所需子字段。
    InstanceMarketOptions InstanceMarketOptionsRequest 实例的市场相关选项,如竞价实例相关参数。
    若修改实例的付费模式为竞价付费,则该参数必传;从竞价付费修改为其他付费模式时,本字段原信息会自动丢弃。
    本字段属复杂类型,修改时采取整字段全覆盖模式。即只修改复杂类型内部一个子字段时,也请提供全部所需子字段。
    DiskTypePolicy String 云盘类型选择策略,取值范围:

  • ORIGINAL:使用设置的云盘类型。

  • AUTOMATIC:自动选择当前可用的云盘类型。
  • SystemDisk SystemDisk 实例系统盘配置信息。
    DataDisks.N Array of DataDisk 实例数据盘配置信息。最多支持指定11块数据盘。采取整体修改,因此请提供修改后的全部值。

    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

    输入示例

    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"
      }
    }

    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
    • Tencent Cloud SDK 3.0 for Java
    • Tencent Cloud SDK 3.0 for PHP
    • Tencent Cloud SDK 3.0 for Go
    • Tencent Cloud SDK 3.0 for NodeJS
    • Tencent Cloud SDK 3.0 for .NET
    • Tencent Cloud SDK 3.0 for C++
    • Tencent Cloud SDK 3.0 for Ruby

    命令行工具

    • Tencent Cloud CLI 3.0

    6. 错误码

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

    错误码 描述
    AccountQualificationRestrictions 该请求账户未通过资格审计。
    CallCvmError CVM接口调用失败。
    InvalidImageId.NotFound 未找到该镜像。
    InvalidLaunchConfigurationId.NotFound 未找到该启动配置。
    InvalidParameter.InvalidCombination 无效的参数组合。
    InvalidParameter.ParameterMustBeDeleted 部分参数存在互斥应该删掉。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.CvmConfigurationError CVM参数校验异常。
    InvalidParameterValue.InstanceTypeNotSupported 实例机型不支持。
    InvalidParameterValue.InvalidImageId 镜像ID无效。
    InvalidParameterValue.InvalidInstanceType 实例机型无效。
    InvalidParameterValue.InvalidLaunchConfigurationId 启动配置ID无效。
    InvalidParameterValue.LaunchConfigurationNameDuplicated 启动配置名称重复。
    InvalidParameterValue.UserDataFormatError UserData格式错误。
    InvalidParameterValue.UserDataSizeExceeded UserData长度过长。
    MissingParameter 缺少参数错误。
    MissingParameter.InScenario 在特定场景下缺少参数。
    ResourceNotFound.LaunchConfigurationIdNotFound 指定的启动配置不存在。

    本站部分内容转载于网络,版权归原作者所有,转载之目的在于传播更多优秀技术内容,如有侵权请联系QQ/微信:153890879删除,谢谢!

    推荐图文

    • 周排行
    • 月排行
    • 总排行

    随机推荐