ModifyScalingRule - 修改一条伸缩规则

更新时间:
复制 MD 格式

修改一条伸缩规则。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ess:ModifyScalingRuleupdate
*ScalingGroup
acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

请求参数

名称类型必填描述示例值
ScalingRuleIdstring

待修改伸缩规则的 ID。

asr-bp1dvirgwkoowxk7****
ScalingRuleNamestring

伸缩规则的名称,由 2~64 个字符组成,以数字、大小字母或中文开头,可包含数字、下划线(_)、短划线(-)或半角句号(.)。

说明 同一用户账号同一地域同一伸缩组内伸缩规则唯一。
scalingrule****
Cooldowninteger

伸缩规则的冷却时间,仅适用于简单规则。

取值范围:0~86400,单位:秒。

60
MinAdjustmentMagnitudeinteger

伸缩规则最小调整实例数,仅当伸缩规则类型为SimpleScalingRuleStepScalingRule,且AdjustmentTypePercentChangeInCapacity时生效。

1
AdjustmentTypestring

伸缩规则的调整方式,适用于简单规则和步进规则,且此时该项必选。取值范围:

  • QuantityChangeInCapacity:增加或减少指定数量的 ECS 实例。
  • PercentChangeInCapacity:增加或减少指定比例的 ECS 实例。
  • TotalCapacity: 将当前伸缩组的 ECS 实例数量调整到指定数量。
QuantityChangeInCapacity
AdjustmentValueinteger

伸缩规则的调整值,适用于简单规则和步进规则,且此时该项必选。任何情况下,单次调整的 ECS 实例台数都不能超过 1000。不同调整方式对应的取值范围:

  • QuantityChangeInCapacity:-1000~1000。
  • PercentChangeInCapacity:-100~10000。
  • TotalCapacity:0~2000。
100
EstimatedInstanceWarmupinteger

实例预热时间,适用于目标追踪规则和步进规则。处于预热状态的 ECS 实例将正常的加入伸缩组,但是期间将不会向云监控上报监控数据。

说明 动态计算需要扩缩容的 ECS 实例数量时,处于预热状态的实例不计入现有实例数量。

取值范围:0~86400,单位:秒。

60
MetricNamestring

预定义监控项,适用于目标追踪规则和预测规则,且此时该项必选。

目标追踪规则取值范围:

  • 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)内网出流量平均值。

更多信息,请参见系统监控报警任务

CpuUtilization
TargetValuefloat

目标值,适用于目标追踪规则和预测规则。TargetValue 最多保留小数点后三位,且必须大于 0。

0.125
DisableScaleInboolean

是否禁用缩容,仅适用于目标追踪规则。

true
ScaleInEvaluationCountinteger

创建目标追踪规则后,会自动创建报警任务。本参数用于指定对应的缩容报警任务触发报警时,所需连续满足阈值条件的次数。

15
ScaleOutEvaluationCountinteger

创建目标追踪规则后,会自动创建报警任务。本参数用于指定对应的扩容报警任务触发报警时,所需连续满足阈值条件的次数。

3
PredictiveScalingModestring

预测规则的模式。取值范围:

  • PredictAndScale:产生预测结果并创建预测任务。
  • PredictOnly:产生预测结果,但不会创建预测任务。
PredictAndScale
PredictiveValueBehaviorstring

预测规则最大值处理方式。取值范围:

  • MaxOverridePredictiveValue:初始最大值会覆盖预测值。预测值大于初始最大值时,预测任务的最大值采用初始最大值。
  • PredictiveValueOverrideMax:预测值会覆盖初始最大值。预测值大于初始最大值时,预测任务的最大值采用预测值。
  • PredictiveValueOverrideMaxWithBuffer:预测值会附加一定比例。预测值会按照 PredictiveValueBuffer 比例增加,当增加后的值大于初始最大值时,会采用增加后的值。
MaxOverridePredictiveValue
PredictiveValueBufferinteger

PredictiveValueBehaviorPredictiveValueOverrideMaxWithBuffer时生效,预测值会按照该比例增加,当增加后的值大于初始最大值时,会采用增加后的值。取值范围:0~100。

50
PredictiveTaskBufferTimeinteger

预测规则自动创建的预测任务默认均在整点执行,您可以设置预启动时间提前执行预测任务,预先准备资源。取值范围:0~60。

30
InitialMaxSizeinteger

伸缩组实例数上限,和 PredictiveValueBehavior 结合使用。

100
StepAdjustmentarray<object>

分步步骤对应的实例扩展信息组成的集合。

object

分步步骤对应的实例扩展信息组成的集合。

MetricIntervalUpperBoundfloat

分步步骤的上边界,仅适用于步进规则。取值范围:-9.999999E18~9.999999E18。

5.0
ScalingAdjustmentinteger

分步步骤对应的实例扩展数量,仅适用于步进规则。

1
MetricIntervalLowerBoundfloat

分步步骤的下边界,仅适用于步进规则。取值范围:-9.999999E18~9.999999E18。

1.0
AlarmDimensionarray<object>

监控项关联的维度信息,适用于目标追踪规则,当监控项需额外维度信息时设置,例如LoadBalancerRealServerAverageQps监控项需指定rulePool维度信息。

object

监控项关联的维度信息,适用于目标追踪规则,当监控项需额外维度信息时设置,例如LoadBalancerRealServerAverageQps监控项需指定rulePool维度信息。

DimensionKeystring

监控项关联的维度信息键。

rulePool
DimensionValuestring

监控项关联的维度信息值。

sgp-l1cbirz451yxu2****
MetricTypestring

监控项类型。取值范围:

  • system:使用云监控系统指标。
  • custom:使用上报到云监控的自定义指标。
  • hybrid:使用企业云监控的指标。
system
HybridMonitorNamespacestring

企业云监控指标仓库 ID。

管理指标仓库,请参见管理指标仓库

aliyun-test
HybridMetricsarray<object>

企业云监控指标设置。如何设置,请参见使用公式运算自定义目标追踪规则

object
Idstring

公制运算表达式中指标的引用 ID。

a
Expressionstring

多个企业云监控指标的公制运算表达式,表达式的计算结果将用于触发扩缩容。

运算表达式需满足逆波兰表达式(RPN)规范,并且操作符只支持+ - * /

(a+b)/2
MetricNamestring

企业云监控指标仓库中的指标名称。

AliyunSmq_NumberOfMessagesVisible
Statisticstring

指标的统计方式。取值范围:

  • Average:指定区间内所有点的平均值。
  • Minimum:指定区间内所有点的最小值。
  • Maximum:指定区间内所有点的最大值。
Average
Dimensionsarray<object>

指标纬度。用于指定指标监控的资源。

object
DimensionKeystring

指标维度 key。

queue
DimensionValuestring

指标维度 value。

testQueue
AlarmOptionsobject

告警属性定义。

Periodinteger

目标追踪规则中统计监控项数据的周期,单位:秒。取值范围:

  • 15。
  • 60。
  • 120。
  • 300。
  • 900。
说明 默认值:60。
60

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

错误码

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

变更历史

变更时间变更内容概要操作
2025-04-29OpenAPI 入参发生变更查看变更详情
2025-02-28OpenAPI 入参发生变更查看变更详情
2025-02-25OpenAPI 描述信息更新查看变更详情
2023-04-03OpenAPI 入参发生变更查看变更详情
HttpCode错误码错误信息描述
404InvalidScalingRuleId.NotFoundThe specified scaling rule does not exist.指定的伸缩组规则在该用户账号下不存在。
400InvalidScalingRuleName.DuplicateThe specified value of parameter is duplicated.伸缩规则名字已存在。
400QuotaExceeded.ScalingRuleScaling rule quota exceeded in the specified scaling group.用户的伸缩规则使用个数达到上限。
400TargetTrackingScalingRule.UnsupportedMetricSpecific metric is not supported for target tracking scaling rule.目标追踪规则不支持当前监控指标。
400TargetTrackingScalingRule.DumplicateMetricOnly one TargetTrackingScaling rule for a given metric specification is allowed.一个伸缩组中,同一监控指标只能存在一条目标追踪规则。
400InvalidMinAdjustmentMagnitudeMismatchAdjustmentTypeMinAdjustmentMagnitude is not supported by the specified adjustment type.MinAdjustmentMagnitude 不支持当前伸缩规则调整类型。
400InvalidStepAdjustments.MultipleNullUpperBoundAt most one StepAdjustment may have an unspecified upper bound.最多只能有一个分步步骤不指定分步上界。
400InvalidStepAdjustments.MultipleNullLowerBoundAt most one StepAdjustment may have an unspecified lower bound.最多只能有一个分步步骤不指定分步下界。
400InvalidStepAdjustments.NoNullLowerBoundThere must be a StepAdjustment with an unspecified lower bound when one StepAdjustment has a negative lower bound.当存在一个分步下界为负数时,则必须有一个未指定分步下界的分步步骤。
400InvalidStepAdjustments.NoNullUpperBoundThere must be a StepAdjustment with an unspecified upper bound when one StepAdjustment has a positive upper bound.当存在一个正数的分步上界时,则必有一个未指定分步上界的分步步骤。
400InvalidStepAdjustments.GapStepAdjustment intervals can not have gaps between them.分步步骤之间不能有间隔。
400InvalidStepAdjustments.OverlapStepAdjustment intervals can not overlap.分步步骤之间不能重叠。
400InvalidStepAdjustments.LowerGtUpperLowerBound must be less than the UpperBound for StepAdjustment :%s.同一分步步骤中,分步下界必须小于分步上界。
400InvalidStepAdjustments.BothNullBoth lower and upper bounds of a StepAdjustment can not be left unspecified.同一分步步骤中,分步上界和分步下界不能同时不指定。
400InvalidStepAdjustments.MaxNumYour scaling rule can have at most %s StepAdjustments.同一伸缩组中分步步骤数量超过阈值。
400StepBeyondPermitRangeSpecific parameter "%s" beyond permit range.分步步骤的上界或下界超过了可选范围。