请登录后查看
- 伸缩活动日志管理
- 查询伸缩活动日志ListScalingActivityLogs
- 查询伸缩活动日志v2版本ListScalingActivityV2Logs
- 伸缩策略日志管理
- 查询策略执行日志ListScalingPolicyExecuteLogs
- 弹性伸缩API管理
- 查询弹性伸缩API所有版本信息ListApiVersions
- 查询弹性伸缩API指定版本信息ShowApiVersion
- 弹性伸缩实例管理
- 批量添加实例BatchAddScalingInstances
- 批量设置实例保护BatchProtectScalingInstances
- 批量移除实例BatchRemoveScalingInstances
- 批量将实例转为备用状态BatchSetScalingInstancesStandby
- 批量取消实例保护BatchUnprotectScalingInstances
- 批量将实例移出备用状态BatchUnsetScalingInstancesStantby
- 移出弹性伸缩组实例DeleteScalingInstance
- 查询弹性伸缩组中的实例列表ListScalingInstances
- 弹性伸缩策略管理
- 批量删除弹性伸缩策略。BatchDeleteScalingPolicies
- 批量停用弹性伸缩策略。BatchPauseScalingPolicies
- 批量启用弹性伸缩策略。BatchResumeScalingPolicies
- 创建弹性伸缩策略CreateScalingPolicy
- 删除弹性伸缩策略DeleteScalingPolicy
- 执行弹性伸缩策略。ExecuteScalingPolicy
- 查询弹性伸缩策略列表ListScalingPolicies
- 停止弹性伸缩策略。PauseScalingPolicy
- 启用弹性伸缩策略。ResumeScalingPolicy
- 查询弹性伸缩策略详情ShowScalingPolicy
- 修改弹性伸缩策略UpdateScalingPolicy
- 弹性伸缩策略管理V2
- 创建弹性伸缩策略(V2版本)CreateScalingV2Policy
- 查询弹性伸缩策略全量列表(V2版本)ListAllScalingV2Policies
- 查询弹性伸缩策略列表(V2版本)ListScalingV2Policies
- 查询指定弹性伸缩策略详情(V2版本)ShowScalingV2Policy
- 修改弹性伸缩策略(V2版本)UpdateScalingV2Policy
- 弹性伸缩组管理
- 创建弹性伸缩组CreateScalingGroup
- 删除弹性伸缩组DeleteScalingGroup
- 查询弹性伸缩组列表ListScalingGroups
- 停止弹性伸缩组PauseScalingGroup
- 启用弹性伸缩组ResumeScalingGroup
- 查询弹性伸缩组详情ShowScalingGroup
- 修改弹性伸缩组UpdateScalingGroup
- 弹性伸缩配置
- 批量删除弹性伸缩配置BatchDeleteScalingConfigs
- 创建弹性伸缩配置CreateScalingConfig
- 删除弹性伸缩配置DeleteScalingConfig
- 查询弹性伸缩配置列表ListScalingConfigs
- 查询弹性伸缩配置详情ShowScalingConfig
- 标签管理
- 创建标签CreateScalingTagInfo
- 删除标签DeleteScalingTagInfo
- 查询资源实例ListResourceInstances
- 查询资源标签ListScalingTagInfosByResourceId
- 查询标签ListScalingTagInfosByTenantId
- 生命周期挂钩管理
- 伸缩实例生命周期回调AttachCallbackInstanceLifeCycleHook
- 创建生命周期挂钩CreateLifyCycleHook
- 删除生命周期挂钩DeleteLifecycleHook
- 查询伸缩实例挂起信息ListHookInstances
- 查询生命周期挂钩列表ListLifeCycleHooks
- 查询生命周期挂钩详情ShowLifeCycleHook
- 修改生命周期挂钩UpdateLifeCycleHook
- 计划任务
- 创建计划任务CreateGroupScheduledTask
- 删除计划任务DeleteGroupScheduledTask
- 查询计划任务列表ListGroupScheduledTasks
- 更新计划任务UpdateGroupScheduledTask
- 通知管理
- 配置伸缩组通知CreateScalingNotification
- 删除伸缩组通知DeleteScalingNotification
- 查询伸缩组通知列表ListScalingNotifications
- 配额管理
- 查询弹性伸缩策略和伸缩实例配额ShowPolicyAndInstanceQuota
- 查询配额ShowResourceQuota
CreateScalingGroup
创建弹性伸缩组
- 非洲-约翰内斯堡
- 亚太-曼谷
- 亚太-雅加达
- 亚太-吉隆坡-OP6
- 亚太-马尼拉
- 亚太-新加坡
- 华东-上海一
- 华东-上海二
- 华北-北京一
- 华北-北京二
- 华北-北京四
- 华北-乌兰察布一
- 华南-广州
- 华南-深圳
- 西南-贵阳一
- 中国-香港
- 欧洲-巴黎
- 拉美-墨西哥城一
- 拉美-墨西哥城二
- 拉美-圣地亚哥
- 拉美-圣保罗一
- 俄罗斯-莫斯科二
- 土耳其-伊斯坦布尔
- 俄罗斯-莫斯科-OP4
- IPV4
- IPV6
- true
- false
- ELB_AUDIT
- NOVA_AUDIT
- OLD_CONFIG_OLD_INSTANCE
- OLD_CONFIG_NEW_INSTANCE
- OLD_INSTANCE
- NEW_INSTANCE
- true
- false
- true
- false
- EQUILIBRIUM_DISTRIBUTE
- PICK_FIRST
本文档信息来源于官网帮助中心
功能介绍
伸缩组是具有相同应用场景的实例的集合，是启停伸缩策略和进行伸缩活动的基本单位。伸缩组内定义了最大实例数、期望实例数、最小实例数、虚拟私有云、子网、负载均衡等信息。
- 默认最多可以创建10个伸缩组。
- 如果伸缩组配置了负载均衡，在添加或移除实例时，会自动为实例绑定或解绑负载均衡监听器。
- 如果伸缩组使用负载均衡健康检查方式，伸缩组中的实例需要启用负载均衡器的监听端口才能通过健康检查。端口启用可在安全组中进行配置，可参考添加安全组规则进行操作。
- 如果您将多个负载均衡器添加到伸缩组，则只有在所有负载均衡器均检测到云服务器状态为正常的情况下，才会认为该弹性云服务器正常。否则只要有一个负载均衡器检测到云服务器状态异常，伸缩组会将该弹性云服务器移出伸缩组。
- 如果您将负载均衡器的多个端口绑定到伸缩组，则只有在所有端口均检测到云服务器状态为正常的情况下，才会认为该弹性云服务器正常。否则只要有一个端口检测到云服务器状态异常，伸缩组会将该弹性云服务器移出伸缩组。
- 当实例绑定负载均衡器的多个端口时，推荐伸缩策略与云服务器实例告警指标关联，避免伸缩策略与单一业务或网络指标关联，否则当不同告警指标分别指向扩容和缩容时，会导致扩缩容同时触发。
- 弹性伸缩活动中，若实例与负载均衡器的多个端口依次绑定或解绑，未全部成功时，则认为实例伸缩失败。扩容触发实例释放并创建新实例，缩容失败不释放实例。
调试
您可以在API Explorer中调试该接口。
URI
POST /autoscaling-api/v1/{project_id}/scaling_group
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
scaling_group_name |
是 |
String |
伸缩组名称(1-64个字符)，只能包含中文、字母、数字、下划线或中划线。 |
|
scaling_configuration_id |
是 |
String |
伸缩配置ID，通过查询弹性伸缩配置列表接口获取，请参考查询弹性伸缩配置列表。 |
|
desire_instance_number |
否 |
Integer |
期望实例数量，默认值为最小实例数。 最小实例数≤期望实例数≤最大实例数。 |
|
min_instance_number |
否 |
Integer |
最小实例数量，默认值为0。 |
|
max_instance_number |
否 |
Integer |
最大实例数量，默认值为1。取值范围为0-300的整数。 |
|
cool_down_time |
否 |
Integer |
冷却时间，取值范围0-86400，默认为300，单位是秒。 在每次伸缩活动完成之后，系统开始计算冷却时间。伸缩组在冷却时间内，会拒绝告警策略的触发，其他类型的伸缩策略（如定时策略和周期策略）及手动触发不受限制。
说明：
|
|
lb_listener_id |
否 |
String |
弹性负载均衡监听器ID，最多支持绑定6个负载均衡监听器，多个负载均衡监听器ID以逗号分隔。获取监听器ID的方法请参考查询负载均衡器列表。 该字段与lbaas_listeners互斥。 |
|
lbaas_listeners |
否 |
Array of lbaas_listeners objects |
弹性负载均衡器信息，最多支持绑定6个负载均衡。列表数据结构请参考表3。获取负载均衡器的信息请参考查询后端云服务器组。 该字段与lb_listener_id互斥。 |
|
available_zones |
否 |
Array of strings |
可用区信息。弹性伸缩活动中自动添加的云服务器会被创建在指定的可用区中。如果没有指定可用区，会由系统自动指定可用区。详情请参考地区和终端节点。 |
|
networks |
是 |
Array of networks objects |
网络信息，最多支持选择5个子网，传入的第一个子网默认作为云服务器的主网卡。获取子网信息请参考查询子网列表。数据结构信息请参考表4。 |
|
security_groups |
否 |
Array of security_groups objects |
安全组信息，仅支持选择1个安全组。获取安全组信息请参考查询安全组列表。数据结构信息请参考表7。 当伸缩配置和伸缩组同时指定安全组时，将以伸缩配置中的安全组为准；当伸缩配置和伸缩组都没有指定安全组时，增加的弹性云服务器将使用默认安全组。为了使用灵活性更高，推荐在伸缩配置中指定安全组。 |
|
vpc_id |
是 |
String |
虚拟私有云（VPC）信息，获取VPC信息具体操作请参考查询VPC列表。 |
|
health_periodic_audit_method |
否 |
String |
伸缩组实例健康检查方式：ELB_AUDIT和NOVA_AUDIT。当伸缩组设置负载均衡时，默认为ELB_AUDIT；否则默认为NOVA_AUDIT。
|
|
health_periodic_audit_time |
否 |
Integer |
伸缩组实例的健康检查周期，可设置为1、5、15、60、180（分钟），若不设置该参数，默认为5。 若设置为0，可以实现10秒级健康检查。 |
|
health_periodic_audit_grace_period |
否 |
Integer |
伸缩组实例健康状况检查宽限期，取值范围0-86400，单位是秒，默认为600。 当实例加入伸缩组并且进入已启用状态后，健康状况检查宽限期才会启动，伸缩组会等健康状况检查宽限期结束后才检查实例的运行状况。 当伸缩组实例健康检查方式为ELB_AUDIT时，该参数生效。 |
|
instance_terminate_policy |
否 |
String |
伸缩组实例移除策略：
|
|
notifications |
否 |
Array of strings |
通知方式： EMAIL为发送邮件通知。 该通知方式已经被废除，建议给弹性伸缩组配置通知功能。请参考通知。 |
|
delete_publicip |
否 |
Boolean |
配置删除云服务器时（即进行实例缩容时，将云服务器从伸缩组中移出）是否删除云服务器绑定的弹性IP。取值为true或false，默认为false。
|
|
delete_volume |
否 |
Boolean |
配置删除云服务器时（即进行实例缩容时，将云服务器从伸缩组中移出）是否删除云服务器绑定的数据盘。取值为true或false，默认为false。
|
|
enterprise_project_id |
否 |
String |
企业项目ID，用于指定伸缩组归属的企业项目。
当伸缩组配置企业项目时，由该伸缩组创建的弹性云服务器将归属于该企业项目。否则将使用默认企业项目。
说明：
关于企业项目特性的详细信息，请参见企业项目管理。 |
|
multi_az_priority_policy |
否 |
String |
伸缩组扩缩容时目标AZ选择的优先级策略：
|
|
description |
否 |
String |
伸缩组描述（1-256个字符）。 |
|
iam_agency_name |
否 |
String |
委托（1-64个字符）。
|
|
tags |
否 |
Array of tags objects |
创建特定标签并将其添加到伸缩组。每个伸缩组最多添加10个标签。 详情请参考表8。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
pool_id |
是 |
String |
后端云服务器组ID |
|
protocol_port |
是 |
Integer |
后端协议号，指后端云服务器监听的端口，取值范围[1, 65535]。 |
|
weight |
是 |
Integer |
权重，指后端云服务器经分发得到的请求数量的比例，取值范围[0, 100]。 |
|
protocol_version |
否 |
String |
绑定到负载均衡云服务器组的IP地址版本，枚举值支持ipv4和ipv6。
说明：
|
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
是 |
String |
子网的网络ID。 |
|
ipv6_enable |
否 |
Boolean |
是否启用IPv6。 true：标识此网卡已启用ipv6。 false：标识此网卡未启用ipv6。默认取值为false。 |
|
ipv6_bandwidth |
否 |
ipv6_bandwidth object |
绑定的IPv6共享带宽。默认为空，表示未绑定IPv6的共享带宽。 |
|
allowed_address_pairs |
否 |
Array of allowed_address_pairs objects |
是否开启源/目的检查开关。 |
请求示例
创建一个伸缩组，伸缩组名称为GroupNameTest，伸缩配置ID为47683a91-93ee-462a-a7d7-484c006f4440，虚拟私有云ID为a8327883-6b07-4497-9c61-68d03ee193a，网卡ID为3cd35bca-5a10-416f-8994-f79169559870，最大实例数为10，期望实例数为0，最小实例数为0，健康检查方式为云服务器健康检查，设置具体企业项目，伸缩组扩缩容时目标AZ选择的优先级策略为PICK_FIRST（选择优先）。
{
"scaling_group_name": "GroupNameTest",
"scaling_configuration_id": "47683a91-93ee-462a-a7d7-484c006f4440",
"desire_instance_number": 0,
"min_instance_number": 0,
"max_instance_number": 10,
"health_periodic_audit_method": "NOVA_AUDIT",
"vpc_id": "a8327883-6b07-4497-9c61-68d03ee193a",
"available_zones": ["XXXa","XXXb"],
"networks": [
{
"id": "3cd35bca-5a10-416f-8994-f79169559870"
}
],
"enterprise_project_id":"c92b1a5d-6f20-43f2-b1b7-7ce35e58e413",
"multi_az_priority_policy":"PICK_FIRST",
"iam_agency_name":"test",
"tags":[{"key":"1"}]
}
响应参数
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
scaling_group_id |
String |
伸缩组ID。 |
响应示例
{
"scaling_group_id": "a8327883-6b07-4497-9c61-68d03ee193a1"
}
返回值
- 正常
- 异常
返回值
说明
400 Bad Request
服务器未能处理请求。
401 Unauthorized
被请求的页面需要用户名和密码。
403 Forbidden
对被请求的页面访问禁止。
404 Not Found
服务器无法找到被请求的页面。
405 Method Not Allowed
请求中指定的方法不被允许。
406 Not Acceptable
服务器生成的响应无法被客户端所接受。
407 Proxy Authentication Required
用户必须首先使用代理服务器进行验证，这样请求才会被处理。
408 Request Timeout
请求超出了服务器的等待时间。
409 Conflict
由于冲突，请求无法被完成。
500 Internal Server Error
请求未完成。服务异常。
501 Not Implemented
请求未完成。服务器不支持所请求的功能。
502 Bad Gateway
请求未完成。服务器从上游服务器收到一个无效的响应。
503 Service Unavailable
请求未完成。系统暂时异常。
504 Gateway Timeout
网关超时。
错误码
请参考错误码。