CreateScalingRule - 弹性伸缩

接口说明

请注意以下参数相关说明：

当AdjustmentType是TotalCapacity时，表示将当前伸缩组的ECS或ECI实例数量调整到指定数量，对应的AdjustmentValue值必须大于等于0。
当AdjustmentType是QuantityChangeInCapacity或PercentChangeInCapacity，对应的AdjustmentValue值为正数表示增加实例、为负数表示减少实例。
当AdjustmentType是PercentChangeInCapacity，弹性伸缩服务以伸缩组当前实例数（Total Capacity）xAdjusmentValue/100，并使用四舍五入原则来确认增加或减少的ECS实例或ECI实例个数。
当伸缩规则指定了冷却时间（Cooldown），则执行该伸缩规则的伸缩活动完成后，会以伸缩规则中指定的冷却时间对伸缩组进行冷却处理，如果伸缩规则未指定冷却时间，则以伸缩组指定的冷却时间（DefaultCooldown）为准。
一个伸缩组内可以创建的伸缩规则数量有限，具体说明请参见使用限制。
返回的伸缩规则唯一标识符（ScalingRuleAri）可以供以下接口使用：
- 在执行伸缩规则（ExecuteScalingRule）的ScalingRuleAri参数中指定，您可以手动执行该伸缩规则。
- 在创建定时任务（CreateScheduledTask）的ScheduledAction参数中指定，用户可以定时执行该伸缩规则。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	CreateScalingRule	系统规定参数。取值：CreateScalingRule。
ScalingGroupId	String	是	asg-bp1ffogfdauy0jw0****	伸缩规则所属伸缩组的ID。
ScalingRuleName	String	否	scalingrule****	伸缩规则的名称.。由2~64个字符组成，以数字、大小字母或中文开头，可包含数字、下划线（_）、短划线（-）或半角句号（.）。同一用户账号同一地域同一伸缩组内伸缩规则唯一。说明如果没有指定该参数，默认值为ScalingRuleId的值。
Cooldown	Integer	否	60	伸缩规则的冷却时间，仅适用于简单规则。取值范围：0~86400，单位：秒。默认值：空。
MinAdjustmentMagnitude	Integer	否	1	伸缩规则最小调整实例数。仅当伸缩规则类型为`SimpleScalingRule`或`StepScalingRule`，且`AdjustmentType`为`PercentChangeInCapacity`时生效。
AdjustmentType	String	否	QuantityChangeInCapacity	伸缩规则的调整方式，适用于简单规则和步进规则，且此时该项必选。取值范围： QuantityChangeInCapacity：增加或减少指定数量的ECS实例。 PercentChangeInCapacity：增加或减少指定比例的ECS实例。 TotalCapacity：将当前伸缩组的ECS实例数量调整到指定数量。
AdjustmentValue	Integer	否	100	伸缩规则的调整值，适用于简单规则和步进规则，且此时该项必选。任何情况下，单次调整的ECS实例台数都不能超过1000。不同调整方式对应的取值范围： QuantityChangeInCapacity：-1000~1000。 PercentChangeInCapacity：-100~10000。 TotalCapacity：0~2000。
ScalingRuleType	String	否	SimpleScalingRule	伸缩规则类型。取值范围： SimpleScalingRule：简单规则。根据调整方式（AdjustmentType）和调整值（AdjustmentValue）调整ECS或ECI实例数量。 TargetTrackingScalingRule：目标追踪规则。根据预定义监控（MetricName）项动态计算需要扩缩容的ECS或ECI实例数量，尽量将预定义监控项的指标值维持在目标值（TargetValue）附近。 StepScalingRule：步进规则，根据阈值和指标值提供分步扩展方式。 PredictiveScalingRule：预测规则，基于机器学习能力分析伸缩组的历史监控数据预测未来监控指标值，并支持自动创建定时任务设置伸缩组边界。默认值：SimpleScalingRule。
EstimatedInstanceWarmup	Integer	否	300	实例预热时间，适用于目标追踪规则和步进规则。处于预热状态的ECS实例将正常的加入伸缩组，但是期间将不会向云监控上报监控数据。说明动态计算需要扩缩容的ECS实例数量时，处于预热状态的实例不计入现有实例数量。取值范围：0~86400，单位：秒。默认值：300。
MetricName	String	否	CpuUtilization	预定义监控项，适用于目标追踪规则和预测规则，且此时该项必选。目标追踪规则取值范围： CpuUtilizationAgent：（Agent）CPU使用率（推荐）。 MemoryUtilization：（Agent）内存（推荐）。 CpuUtilization：（ECS）平均CPU使用率。 IntranetTx：（ECS）内网出流量的平均值。 IntranetRx：（ECS）内网入流量的平均值。 VpcInternetTx：（ECS）公网出流量的平均值。 VpcInternetRx：（ECS）公网入流量的平均值。 LoadBalancerRealServerAverageQps：（ALB）服务器组单机QPS。预测规则取值范围： CpuUtilization：（ECS）平均CPU使用率。 IntranetRx：（ECS）内网入流量平均值。 IntranetTx ：（ECS）内网出流量平均值。更多信息，请参见系统监控报警任务。
TargetValue	Float	否	0.125	目标值，适用于目标追踪规则和预测规则，且此时该项必选。TargetValue最多保留小数点后三位，且必须大于0。
DisableScaleIn	Boolean	否	false	是否禁用缩容，仅适用于目标追踪规则。默认值：false。
ScaleInEvaluationCount	Integer	否	15	创建目标追踪规则后，会自动创建报警任务。本参数用于指定对应的缩容报警任务触发报警时，所需连续满足阈值条件的次数。默认值：15。
ScaleOutEvaluationCount	Integer	否	3	创建目标追踪规则后，会自动创建报警任务。本参数用于指定对应的扩容报警任务触发报警时，所需连续满足阈值条件的次数。默认值：3。
PredictiveScalingMode	String	否	PredictAndScale	预测规则的模式，取值范围： PredictAndScale：产生预测结果并创建预测任务。 PredictOnly：产生预测结果，但不会创建预测任务。默认值：PredictAndScale。
PredictiveValueBehavior	String	否	MaxOverridePredictiveValue	预测规则最大值处理方式，取值范围： MaxOverridePredictiveValue：初始最大值会覆盖预测值。预测值大于初始最大值时，预测任务的最大值采用初始最大值。 PredictiveValueOverrideMax：预测值会覆盖初始最大值。预测值大于初始最大值时，预测任务的最大值采用预测值。 PredictiveValueOverrideMaxWithBuffer：预测值会附加一定比例。预测值会按照PredictiveValueBuffer比例增加，当增加后的值大于初始最大值时，会采用增加后的值。默认值：MaxOverridePredictiveValue。
PredictiveValueBuffer	Integer	否	50	`PredictiveValueBehavior`为`PredictiveValueOverrideMaxWithBuffer`时生效，预测值会按照该比例增加，当增加后的值大于初始最大值时，会采用增加后的值。取值范围：0~100。默认值：0。
PredictiveTaskBufferTime	Integer	否	30	预测规则自动创建的预测任务默认均在整点执行，您可以设置预启动时间提前执行预测任务，预先准备资源。取值范围：0~60，单位：分钟。默认值：0。
InitialMaxSize	Integer	否	100	伸缩组实例数上限，和PredictiveValueBehavior结合使用。默认值为伸缩组最大实例数（MaxSize的值）。
StepAdjustment.N.MetricIntervalUpperBound	Float	否	5.0	分步步骤的上边界，仅适用于步进规则，取值范围：-9.999999E18~9.999999E18。
StepAdjustment.N.ScalingAdjustment	Integer	否	1	分步步骤对应的实例扩展数量，仅适用于步进规则。
StepAdjustment.N.MetricIntervalLowerBound	Float	否	1.0	分步步骤的下边界，仅适用于步进规则，取值范围：-9.999999E18~9.999999E18。
RegionId	String	否	cn-hangzhou	伸缩组所属的地域ID。
AlarmDimension.N.DimensionKey	String	否	rulePool	监控项关联的维度信息键。
AlarmDimension.N.DimensionValue	String	否	sgp-l1cbirz451yxu2****	监控项关联的维度信息值。

返回数据

名称	类型	示例值	描述
ScalingRuleAri	String	ari:acs:ess:cn-hangzhou:140692647406**:scalingrule/asr-bp1dvirgwkoowxk7**	伸缩规则的唯一标识符。
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****	请求ID。
ScalingRuleId	String	asr-bp1dvirgwkoowxk7****	伸缩规则的ID，由系统生成，全局唯一。

示例

请求示例

http(s)://ess.aliyuncs.com/?Action=CreateScalingRule
&ScalingGroupId=asg-bp1ffogfdauy0jw0****
&ScalingRuleName=scalingrule****
&Cooldown=60
&MinAdjustmentMagnitude=1
&AdjustmentType=QuantityChangeInCapacity
&AdjustmentValue=100
&ScalingRuleType=SimpleScalingRule
&EstimatedInstanceWarmup=300
&MetricName=CpuUtilization
&TargetValue=0.125
&DisableScaleIn=false
&ScaleInEvaluationCount=15
&ScaleOutEvaluationCount=3
&PredictiveScalingMode=PredictAndScale
&PredictiveValueBehavior=MaxOverridePredictiveValue
&PredictiveValueBuffer=50
&PredictiveTaskBufferTime=30
&InitialMaxSize=100
&StepAdjustment=[{"MetricIntervalUpperBound":5.0,"ScalingAdjustment":1,"MetricIntervalLowerBound":1.0}]
&RegionId=cn-hangzhou
&AlarmDimension=[{"DimensionKey":"rulePool","DimensionValue":"sgp-l1cbirz451yxu2****"}]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateScalingRuleResponse>
    <ScalingRuleAri>ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****</ScalingRuleAri>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <ScalingRuleId>asr-bp1dvirgwkoowxk7****</ScalingRuleId>
</CreateScalingRuleResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "ScalingRuleAri" : "ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****",
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "ScalingRuleId" : "asr-bp1dvirgwkoowxk7****"
}

错误码

访问错误中心查看更多错误码。

HttpCode	错误码	错误信息	描述
404	InvalidScalingGroupId.NotFound	The specified scaling group does not exist.	指定的伸缩组在该用户账号下不存在。
400	InvalidScalingRuleName.Duplicate	The specified value of parameter <parameter name> is duplicated.	伸缩规则名字已存在。
400	QuotaExceeded.ScalingRule	Scaling rule quota exceeded in the specified scaling group.	用户的伸缩规则使用个数达到上限。
400	TargetTrackingScalingRule.UnsupportedMetric	Specific metric is not supported for target tracking scaling rule.	目标追踪规则不支持当前监控指标。
400	TargetTrackingScalingRule.DumplicateMetric	Only one TargetTrackingScaling rule for a given metric specification is allowed.	一个伸缩组中，同一监控指标只能存在一条目标追踪规则。
400	InvalidMinAdjustmentMagnitudeMismatchAdjustmentType	MinAdjustmentMagnitude is not supported by the specified adjustment type.	MinAdjustmentMagnitude不支持当前伸缩规则调整类型。
400	InvalidStepAdjustments.MultipleNullUpperBound	At most one StepAdjustment may have an unspecified upper bound.	最多只能有一个分步步骤不指定分步上界。
400	InvalidStepAdjustments.MultipleNullLowerBound	At most one StepAdjustment may have an unspecified lower bound.	最多只能有一个分步步骤不指定分步下界。
400	InvalidStepAdjustments.NoNullLowerBound	There must be a StepAdjustment with an unspecified lower bound when one StepAdjustment has a negative lower bound.	当存在一个分步下界为负数时，则必须有一个未指定分步下界的分步步骤。
400	InvalidStepAdjustments.NoNullUpperBound	There must be a StepAdjustment with an unspecified upper bound when one StepAdjustment has a positive upper bound.	当存在一个正数的分步上界时，则必有一个未指定分步上界的分步步骤。
400	InvalidStepAdjustments.Gap	StepAdjustment intervals can not have gaps between them.	分步步骤之间不能有间隔。
400	InvalidStepAdjustments.Overlap	StepAdjustment intervals can not overlap.	分步步骤之间不能重叠。
400	InvalidStepAdjustments.LowerGtUpper	LowerBound must be less than the UpperBound for StepAdjustment :%s.	同一分步步骤中，分步下界必须小于分步上界。
400	InvalidStepAdjustments.BothNull	Both lower and upper bounds of a StepAdjustment can not be left unspecified.	同一分步步骤中，分步上界和分步下界不能同时不指定。
400	InvalidStepAdjustments.MaxNum	Your scaling rule can have at most %s StepAdjustments.	同一伸缩组中分步步骤数量超过阈值。
400	StepBeyondPermitRange	Specific parameter "%s" beyond permit range.	分步步骤的上界或下界超过了可选范围。