创建启动配置

最近更新时间:2018-11-15 15:47:55

1. 接口描述

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

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

  • 启动配置无法编辑更改。如需使用新的启动配置,只能重新创建启动配置。

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

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

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

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。该参数可以通过调用 DescribeProject 的返回值中的projectId字段来获取。不填为默认项目。
    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:竞价付费
  • InstanceMarketOptions InstanceMarketOptionsRequest 实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。
    InstanceTypes.N Array of String 实例机型列表,不同实例机型指定了不同的资源规格,最多支持5中实例机型。
    InstanceTypeInstanceTypes参数互斥,二者必填一个且只能填写一个。

    3. 输出参数

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

    4. 示例

    示例1 简单参数创建

    输入示例

    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 详细参数创建

    输入示例

    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 创建竞价实例配置

    输入示例

    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 创建启动配置,支持多种实例机型

    输入示例

    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 Explorer

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    AccountQualificationRestrictions 该请求账户未通过资格审计。
    CallCvmError CVM接口调用失败。
    InvalidImageId.NotFound 未找到该镜像。
    InvalidLaunchConfiguration.NameDuplicate 启动配置名称重复。
    InvalidParameter.Conflict 参数冲突,指定的多个参数冲突,不能同时存在。
    InvalidParameter.MustOneParameter 参数缺失,两种参数之中必须指定其中一个。
    InvalidPermission 账户不支持该操作。
    LaunchConfigurationQuotaLimitExceeded 启动配置配额超过限制。