创建启动配置

最近更新时间:2021-10-25 08:01:27

我的收藏

1. 接口描述

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

本接口(CreateLaunchConfiguration)用于创建新的启动配置。

  • 启动配置,可以通过 ModifyLaunchConfigurationAttributes 修改少量字段。如需使用新的启动配置,建议重新创建启动配置。

  • 每个项目最多只能创建20个启动配置,详见使用限制

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateLaunchConfiguration。
Version String 公共参数,本接口取值:2018-04-19。
Region String 公共参数,详见产品支持的 地域列表
LaunchConfigurationName String 启动配置显示名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。
ImageId String 指定有效的镜像ID,格式形如img-8toqc6s3。镜像类型分为四种:
  • 公共镜像
  • 自定义镜像
  • 共享镜像
  • 服务市场镜像

  • 可通过以下方式获取可用的镜像ID:
  • 公共镜像自定义镜像共享镜像的镜像ID可通过登录控制台查询;服务镜像市场的镜像ID可通过云市场查询。
  • 通过调用接口 DescribeImages ,取返回信息中的ImageId字段。
  • ProjectId Integer 启动配置所属项目ID。不填为默认项目。
    注意:伸缩组内实例所属项目ID取伸缩组项目ID,与这里取值无关。
    InstanceType String 实例机型。不同实例机型指定了不同的资源规格,具体取值可通过调用接口 DescribeInstanceTypeConfigs 来获得最新的规格表或参见实例类型描述。
    InstanceTypeInstanceTypes参数互斥,二者必填一个且只能填写一个。
    SystemDisk SystemDisk 实例系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
    DataDisks.N Array of DataDisk 实例数据盘配置信息。若不指定该参数,则默认不购买数据盘,最多支持指定11块数据盘。
    InternetAccessible InternetAccessible 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
    LoginSettings LoginSettings 实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码,并以站内信方式知会到用户。
    SecurityGroupIds.N Array of String 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的SecurityGroupId字段来获取。若不指定该参数,则默认不绑定安全组。
    EnhancedService EnhancedService 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认开启云监控、云安全服务。
    UserData String 经过 Base64 编码后的自定义数据,最大长度不超过16KB。
    InstanceChargeType String 实例计费类型,CVM默认值按照POSTPAID_BY_HOUR处理。

  • POSTPAID_BY_HOUR:按小时后付费

  • SPOTPAID:竞价付费

  • PREPAID:预付费,即包年包月
  • InstanceMarketOptions InstanceMarketOptionsRequest 实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。
    InstanceTypes.N Array of String 实例机型列表,不同实例机型指定了不同的资源规格,最多支持10种实例机型。
    InstanceTypeInstanceTypes参数互斥,二者必填一个且只能填写一个。
    InstanceTypesCheckPolicy String 实例类型校验策略,取值包括 ALL 和 ANY,默认取值为ANY。

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

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

    实例类型不可用的常见原因包括该实例类型售罄、对应云盘售罄等。
    如果 InstanceTypes 中一款机型不存在或者已下线,则无论 InstanceTypesCheckPolicy 采用何种取值,都会校验报错。
  • InstanceTags.N Array of InstanceTag 标签列表。通过指定该参数,可以为扩容的实例绑定标签。最多支持指定10个标签。
    CamRoleName String CAM角色名称。可通过DescribeRoleList接口返回值中的roleName获取。
    HostNameSettings HostNameSettings 云服务器主机名(HostName)的相关设置。
    InstanceNameSettings InstanceNameSettings 云服务器实例名(InstanceName)的相关设置。
    如果用户在启动配置中设置此字段,则伸缩组创建出的实例 InstanceName 参照此字段进行设置,并传递给 CVM;如果用户未在启动配置中设置此字段,则伸缩组创建出的实例 InstanceName 按照“as-{{ 伸缩组AutoScalingGroupName }}”进行设置,并传递给 CVM。
    InstanceChargePrepaid InstanceChargePrepaid 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
    DiskTypePolicy String 云盘类型选择策略,默认取值 ORIGINAL,取值范围:

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

  • AUTOMATIC:自动选择当前可用的云盘类型
  • 3. 输出参数

    参数名称 类型 描述
    LaunchConfigurationId String 当通过本接口来创建启动配置时会返回该参数,表示启动配置ID。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 简单参数创建

    只传必传的启动配置名称,实例机型,镜像ID,其他均采用系统默认值,具体配置如下:启动配置名称为:as_test,实例机型为:标准2型 1C1G(S2.SMALL1),镜像ID为:img-8toqc6s3。

    输入示例

    https://as.tencentcloudapi.com/?Action=CreateLaunchConfiguration
    &LaunchConfigurationName=as_test
    &InstanceType=S2.SMALL1
    &ImageId=img-8toqc6s3
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "LaunchConfigurationId": "asc-23h37kyn",
        "RequestId": "d639dd64-9e46-4246-b13c-80954f81c11b"
      }
    }

    示例2 详细参数创建

    启动配置名称为:as_test,镜像ID为:img-8toqc6s3,选择机型为:标准2型 1C1G(S2.SMALL1),系统盘选择 50G 本地硬盘,数据盘选择100G 普通云硬盘,公网付费模式为流量按小时后付费,外网带宽上限 5 Mbps,分配公网IP,选择密钥登录,安装云监控云安全。

    输入示例

    https://as.tencentcloudapi.com/?Action=CreateLaunchConfiguration
    &LaunchConfigurationName=as_test
    &ImageId=img-8toqc6s3
    &InstanceType=S2.SMALL1
    &SystemDisk.DiskType=LOCAL_BASIC
    &SystemDisk.DiskSize=50
    &DataDisks.0.DiskType=CLOUD_BASIC
    &DataDisks.0.DiskSize=100
    &InternetAccessible.InternetChargeType=TRAFFIC_POSTPAID_BY_HOUR
    &InternetAccessible.InternetMaxBandwidthOut=5
    &InternetAccessible.PublicIpAssigned=TRUE
    &LoginSettings.KeyIds.0=skey-k8eypc1l
    &EnhancedService.SecurityService.Enabled=TRUE
    &EnhancedService.MonitorService.Enabled=TRUE
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "LaunchConfigurationId": "asc-fdz8j7dh",
        "RequestId": "9a7209d3-2260-49d7-952a-dfa2001f8822"
      }
    }

    示例3 创建竞价实例配置

    启动配置名称为:spot-test,机型为:标准2型 2C4G(S2.MEDIUM4),计费配置为竞价(SPOTPAID),最高出价为0.99元/小时。

    输入示例

    https://as.tencentcloudapi.com/?Action=CreateLaunchConfiguration
    &LaunchConfigurationName=spot-test
    &InstanceType=S2.MEDIUM4
    &ImageId=img-8toqc6s3
    &SystemDisk.DiskType=CLOUD_PREMIUM
    &SystemDisk.DiskSize=50
    &InternetAccessible.InternetChargeType=TRAFFIC_POSTPAID_BY_HOUR
    &InternetAccessible.InternetMaxBandwidthOut=20
    &InternetAccessible.PublicIpAssigned=true
    &InstanceChargeType=SPOTPAID
    &InstanceMarketOptions.MarketType=spot
    &InstanceMarketOptions.SpotOptions.MaxPrice=0.99
    &InstanceMarketOptions.SpotOptions.SpotInstanceType=one-time
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "LaunchConfigurationId": "asc-hpzwe3o2",
        "RequestId": "ccfe3052-e9c9-47ee-bf3d-5bc2dfd972c0"
      }
    }

    示例4 创建启动配置,支持多种实例机型

    支持两种实例机型,分别是S2.SMALL2和S2.SMALL4

    输入示例

    https://as.tencentcloudapi.com/?Action=CreateLaunchConfiguration
    &LaunchConfigurationName=multi_instance_types
    &InstanceTypes.0=S2.SMALL2
    &InstanceTypes.1=S2.SMALL4
    &ImageId=img-8toqc6s3
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "LaunchConfigurationId": "asc-77mh1cho",
        "RequestId": "2864c860-27a0-439e-a1e1-0003b76734e7"
      }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameter.Conflict 参数冲突,指定的多个参数冲突,不能同时存在。
    InvalidParameter.HostNameUnavailable 主机名参数不适用于该镜像。
    InvalidParameter.InvalidCombination 无效的参数组合。
    InvalidParameter.MustOneParameter 参数缺失,两种参数之中必须指定其中一个。
    InvalidParameter.ParameterMustBeDeleted 部分参数存在互斥应该删掉。
    InvalidParameterValue.CvmConfigurationError CVM参数校验异常。
    InvalidParameterValue.HostNameIllegal 主机名不合法。
    InvalidParameterValue.InstanceNameIllegal 设置的实例名称不合法。
    InvalidParameterValue.InstanceTypeNotSupported 实例机型不支持。
    InvalidParameterValue.InvalidImageId 镜像ID无效。
    InvalidParameterValue.InvalidInstanceType 实例机型无效。
    InvalidParameterValue.InvalidLaunchConfiguration 输入的启动配置无效。
    InvalidParameterValue.InvalidSnapshotId 快照ID无效。
    InvalidParameterValue.LaunchConfigurationNameDuplicated 启动配置名称重复。
    InvalidParameterValue.LimitExceeded 取值超出限制。
    InvalidParameterValue.NotStringTypeFloat 提供的值不是浮点字符串格式。
    InvalidParameterValue.ProjectIdNotFound 项目ID不存在。
    InvalidParameterValue.TooLong 取值过多。
    InvalidParameterValue.UserDataFormatError UserData格式错误。
    InvalidParameterValue.UserDataSizeExceeded UserData长度过长。
    InvalidPermission 账户不支持该操作。
    LimitExceeded.LaunchConfigurationQuotaNotEnough 启动配置配额不足。
    MissingParameter 缺少参数错误。
    MissingParameter.InstanceMarketOptions 竞价计费类型缺少对应的 InstanceMarketOptions 参数。
    目录