说明:当前页面接口为旧版 API,未来可能停止维护。容器服务 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 容器服务 API 3.0。
接口描述
本接口(CreateClusterAsg)用于新建集群伸缩组。
接口请求域名:
ccs.api.qcloud.com
输入参数
以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。
参数名称 | 描述 | 必选 | 类型 |
---|---|---|---|
clusterId | 集群 ID,请填写 查询集群列表 接口中返回的 clusterId 字段 | 是 | String |
instanceId | 参考 CVM,必须是集群内的节点。请填写 查询集群节点列表 接口中返回的 instanceId 字段。会根据此节点的配置(包括 vCPU、内存、机型、VPC、子网、系统盘、数据盘类型和大小、带宽、带宽计费模式、是否分配公网 IP 等)生成扩容时的启动配置 | 是 | String |
minSize | 伸缩组最小值 | 是 | Int |
maxSize | 伸缩组最大值,伸缩组的最大值弹性伸缩本身有限制,详见弹性伸缩说明文档 | 是 | Int |
password | 节点密码。未设置则为随机产生,并通过站内信下发。密码长度要求 8 到 16 位,至少包括字母(小写 a ~ z,大写 A~Z)、数字(0-9)和特殊字符( ( ) ` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' < > , . ? / ) 其中的两项 | 否 | String |
keyId | 密钥 ID。关联密钥后可使用密钥登录节点,keyId 可通过接口 查询密钥 获取,密钥与密码不能同时指定 | 否 | String |
label | label | 否 | Array |
autoScalingGroupName | 伸缩组名称,不指定时默认生成,伸缩组名称不能重名 | 否 | String |
launchConfigurationName | 启动配置名称,不指定时默认生成,启动配置名称不能重名 | 否 | String |
输出参数
参数名称 | 描述 | 类型 |
---|---|---|
code | 公共错误码。0 表示成功,其他值表示失败 | Int |
codeDesc | 业务侧错误码。成功时返回 Success,错误时返回具体业务错误原因 | String |
message | 模块错误信息描述,与接口相关 | String |
示例
输入
https://domain/v2/index.php?Action=CreateClusterAsg
&clusterId=cls-xxxxxxxx
&instanceId=ins-xxxxxxxx
&password=yourpass
&minSize=0
&maxSize=10
&label.yourkey=yourval
&autoScalingGroupName=yourasgname
&launchConfigurationName=yourlcname
&其它公共参数
输出
{
"code": 0,
"message": "",
"codeDesc": "Success",
"data": {
"requestId": 4411
}
}