全部产品
Search
文档中心

弹性伸缩:ModifyScalingRule - 修改一条伸缩规则

更新时间:Dec 12, 2024

创建伸缩规则后,如果当前伸缩规则不再满足需求,您可以调用API ModifyScalingRule修改一项或多项伸缩规则属性,无需重新创建新的伸缩规则,避免不必要的重复操作,节约时间和资源成本。

调试

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

授权信息

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

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

请求参数

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

待修改伸缩规则的 ID。

asr-bp1dvirgwkoowxk7****
ScalingRuleNamestring

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

同一用户账号同一地域同一伸缩组内伸缩规则唯一。

scalingrule****
Cooldowninteger

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

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

60
MinAdjustmentMagnitudeinteger

伸缩规则最小调整实例数,仅当伸缩规则类型为 SimpleScalingRule 或 StepScalingRule,且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
StepAdjustmentsarray<object>

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

object

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

MetricIntervalUpperBoundfloat

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

5.0
ScalingAdjustmentinteger

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

1
MetricIntervalLowerBoundfloat

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

1.0
AlarmDimensionsarray<object>

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

object

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

DimensionKeystring

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

rulePool
DimensionValuestring

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

sgp-l1cbirz451yxu2dxxx

返回参数

名称类型描述示例值
object

修改伸缩规则的返回信息。

RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2024-09-13OpenAPI 入参发生变更查看变更详情
2023-04-03OpenAPI 入参发生变更查看变更详情