修改启动配置属性

最近更新时间: 2024-10-18 10:38:34

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 公共参数,详见产品支持的地域列表(TODO)
LaunchConfigurationId String 启动配置ID
ImageId String 指定有效的镜像ID,格式形如img-8toqc6s3。镜像类型分为四种:<br/><li>公共镜像</li><li>自定义镜像</li><li>共享镜像</li><li>服务市场镜像</li><br/>可通过以下方式获取可用的镜像ID:<br/><li>公共镜像自定义镜像共享镜像的镜像ID可通过登录控制台查询。</li><li>通过调用接口 DescribeImages ,取返回信息中的ImageId字段。</li>
InstanceTypes Array of String 实例类型列表,不同实例机型指定了不同的资源规格,最多支持5种实例机型。<br>启动配置,通过 InstanceType 表示单一实例类型,通过 InstanceTypes 表示多实例类型。指定 InstanceTypes 成功启动配置后,原有的 InstanceType 自动失效。
InstanceTypesCheckPolicy String 实例类型校验策略,在实际修改 InstanceTypes 时发挥作用,取值包括 ALL 和 ANY,默认取值为ANY。<br><br><li> ALL,所有实例类型(InstanceType)都可用则通过校验,否则校验报错。<br><br><li> ANY,存在任何一个实例类型(InstanceType)可用则通过校验,否则校验报错。<br><br>实例类型不可用的常见原因包括该实例类型售罄、对应云盘售罄等。<br>如果 InstanceTypes 中一款机型不存在或者已下线,则无论 InstanceTypesCheckPolicy 采用何种取值,都会校验报错。
LaunchConfigurationName String 启动配置显示名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。
UserData String 经过 Base64 编码后的自定义数据,最大长度不超过16KB。如果要清空UserData,则指定其为空字符串

3. 输出参数

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

4. 错误码

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

错误码 描述
AccountQualificationRestrictions
InvalidParameterValue.LaunchConfigurationNameDuplicated
InvalidParameterValue.CvmConfigurationError
InvalidImageId.NotFound
CallCvmError
InvalidParameterValue.InstanceTypeNotSupported