创建一个伸缩组
接口功能介绍
创建一个弹性伸缩组。
接口约束
伸缩组名称不能重复。
URI
POST /v4/scaling/group/create
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数名 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| securityGroupIDList | 是 | Array of Strings | 安全组ID列表，非多可用区资源池不使用该参数，其安全组参数在弹性伸缩配置中填写 | ['sg-nd1h63d2j8'] | |
| recoveryMode | 是 | Integer | 实例回收模式。取值范围：1：释放模式。2：停机回收模式。 | 1 | |
| name | 是 | String | 伸缩组名称 | as-group-901f | |
| healthMode | 是 | Integer | 健康检查方式。取值范围： 1：云服务器健康检查。2：弹性负载均衡健康检查。 | 1 | |
| mazInfo | 否 | Array of Objects | 【Deprecated】多可用区资源池的实例可用区及子网信息。mazInfo和subnetIDList参数互斥，如果资源池为多可用区时使用mazInfo则不传subnetIDList参数 | mazInfo | |
| subnetIDList | 否 | Array of Strings | 子网ID列表。支持一主多辅，最大支持输入5个网卡信息，顺序第一个网卡信息默认主网卡。mazInfo和subnetIDList参数互斥。 | ['a8ffac57-354b-41af-b853-53b5cded4957'] | |
| moveOutStrategy | 是 | Integer | 实例移出策略。取值范围：1：较早创建的配置较早创建的云主机。2：较晚创建的配置较晚创建的云主机。3：较早创建的云主机。4：较晚创建的云主机。 | 1 | |
| useLb | 是 | Integer | 是否使用负载均衡。取值范围： 1：是 。 2：否。 | 2 | |
| vpcID | 是 | String | 虚拟私有云ID | vpc-0wvmt7gh02 | |
| minCount | 是 | Integer | 最小云主机数，取值范围：[0,50] | 0 | |
| maxCount | 是 | Integer | 最大云主机数，取值范围：[minCount,2147483647] | 50 | |
| expectedCount | 否 | Integer | 期望云主机数，取值范围：[minCount,maxCount]，非多可用区资源池不支持该参数 | 0 | |
| healthPeriod | 是 | Integer | 健康检查时间间隔（周期），单位：秒，取值范围：[300,10080] | 300 | |
| lbList | 否 | Array of Objects | 负载均衡列表，useLb=1时必填 | lbList | |
| projectID | 否 | String | 企业项目ID | 0 | |
| configID | 否 | Integer | 【Deprecated】伸缩配置ID | 375 | |
| configList | 否 | Array of Integers | 伸缩配置ID列表，最大支持传入10个伸缩配置。按输入伸缩配置的顺序，决定伸缩配置优先级。注意：该参数与configID不可同时传入，请尽量选择本参数。 | [375] | |
| azStrategy | 否 | Integer | 扩容策略类型，仅多可用区资源池支持，多可用区资源池必填。取值范围：1：均衡分布。 2：优先级分布。 | 1 |
表 mazInfo
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| masterId | 是 | String | 主网卡，子网可跨可用区 | subnet-9fr7iesyyp | |
| azName | 是 | String | 可用区名称 | az1 | |
| optionId | 否 | Array of Strings | 扩展网卡列表 |
表 lbList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| port | 是 | Integer | 端口号 | 2235 | |
| lbID | 是 | String | 负载均衡ID | lb-la9ik6vb5y | |
| weight | 是 | Integer | 权重 | 1 | |
| hostGroupID | 是 | String | 后端主机组ID | tg-j36kny3khn |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回码：800表示成功，900表示失败 | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码 | Scaling.Group.NotFound | 错误码 |
| message | String | 失败时的错误描述，一般为英文描述 | scaling group info not found | |
| description | String | 失败时的错误描述，一般为中文描述 | 未找到弹性伸缩组信息 | |
| returnObj | Object | 成功时返回的数据，参见表returnObj | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| groupID | Integer | 伸缩组ID | 489 |
请求示例
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"securityGroupIDList": [
"sg-nsgrzc3j8o"
],
"recoveryMode": 1,
"name": "as-group-3f2b1",
"healthMode": 1,
"moveOutStrategy": 1,
"useLb": 2,
"vpcID": "vpc-d9m7zwykvs",
"minCount": 0,
"maxCount": 100,
"healthPeriod": 300,
"subnetIDList":["subnet-mm1z4zbkfv","subnet-16szf88gta"],
"configList": [3881,3880],
"azStrategy": 1
}
响应示例
{
"returnObj": {
"groupID": 493
},
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
错误码
| errorCode | 描述 |
|---|---|
| Scaling.Group.HealthModeNotSupported | 不支持该健康检查方式 |
| Scaling.Group.RecoveryModeNotSupported | 不支持该云主机回收模式 |
| Scaling.Group.UseLbNotSupported | 不支持该方式 |
| Scaling.Group.GroupNumberMoreThanLimit | 弹性伸缩组数量超过限制 |
| Scaling.Group.GroupNameExists | 伸缩组名重复 |
| Scaling.OrderCheck.SubnetNotExists | 子网不存在 |
| Scaling.OrderCheck.VpcNotExists | 虚拟私有云不存在 |
| Openapi.Workorder.AccessFailed | 系统错误 |
