创建集群的伸缩组

最近更新时间:2019-10-18 11:15:11

1. 接口描述

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

为已经存在的集群创建伸缩组

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateClusterAsGroup
Version String 公共参数,本接口取值:2018-05-25
Region String 公共参数,详见产品支持的 地域列表
ClusterId String 集群ID
AutoScalingGroupPara String 伸缩组创建透传参数,json化字符串格式,详见伸缩组创建实例接口。LaunchConfigurationId由LaunchConfigurePara参数创建,不支持填写
LaunchConfigurePara String 启动配置创建透传参数,json化字符串格式,详见创建启动配置接口。另外ImageId参数由于集群维度已经有的ImageId信息,这个字段不需要填写。UserData字段设置通过UserScript设置,这个字段不需要填写。
InstanceAdvancedSettings InstanceAdvancedSettings 节点高级配置信息
Labels.N Array of Label 节点Label数组

3. 输出参数

参数名称 类型 描述
LaunchConfigurationId String 启动配置ID
AutoScalingGroupId String 伸缩组ID
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建集群的伸缩组

创建集群的伸缩组

输入示例

https://tke.tencentcloudapi.com/?Action=CreateClusterAsGroup
&ClusterId=cls-xxxxxx
&AutoScalingGroupPara="{"AutoScalingGroupName":"001","MaxSize":5,"MinSize":0,"VpcId":"vpc-xxxxxxx","SubnetIds":["subnet-xxxxxxx"],"RetryPolicy":"IMMEDIATE_RETRY"}"
&LaunchConfigurePara="{"LaunchConfigurationName":"","InstanceType":"S4.SMALL1","SystemDisk":{"DiskType":"CLOUD_PREMIUM","DiskSize":50},"InternetAccessible":{"InternetChargeType":"TRAFFIC_POSTPAID_BY_HOUR","InternetMaxBandwidthOut":1,"PublicIpAssigned":true},"LoginSettings":{"Password":"YourPassword"},"SecurityGroupIds":["sg-xxxxxxx"],"EnhancedService":{"SecurityService":{"Enabled":true},"MonitorService":{"Enabled":true}},"InstanceChargeType":"POSTPAID_BY_HOUR"}"
&<公共请求参数>

输出示例

{
  "Response": {
    "AutoScalingGroupId": "asg-xxxxxxx",
    "LaunchConfigurationId": "asc-xxxxxxxx",
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
InternalError 内部错误
InternalError.AccountUserNotAuthenticated 账户未通过认证。
InternalError.AsCommon 伸缩组资源创建报错。
InternalError.CvmCommon cvm创建节点报错。
InternalError.CvmNotFound cvm不存在。
InternalError.Db db错误。
InternalError.DbAffectivedRows DB错误
InternalError.ImageIdNotFound 镜像未找到。
InternalError.OsNotSupport 镜像OS不支持。
InternalError.Param Param。
InvalidParameter 参数错误
InvalidParameter.AsCommonError 弹性伸缩组创建参数错误。
LimitExceeded 超过配额限制
MissingParameter 缺少参数错误
UnsupportedOperation 操作不支持