文档

DescribeScalingRules - 查询伸缩规则

调用DescribeScalingRules并指定伸缩规则ID、伸缩规则名称、伸缩规则唯一标识符等参数,查询伸缩规则及其详细信息。例如,伸缩规则的调整方式、实例预热时间、伸缩规则关联的报警任务信息等。

调试

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

授权信息

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

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

请求参数

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

伸缩规则所属伸缩组的地域 ID。

cn-qingdao
PageNumberinteger

伸缩规则列表的页码,起始值:1。

默认值:1。

1
PageSizeinteger

分页查询时设置的每页行数,最大值:50。

默认值:10。

50
ScalingGroupIdstring

伸缩组的 ID。

asg-bp1ffogfdauy0jw0****
ScalingRuleTypestring

伸缩规则的类型。取值范围:

  • SimpleScalingRule:简单规则。根据调整方式(AdjustmentType)和调整值(AdjustmentValue)调整 ECS 实例数量。
  • TargetTrackingScalingRule:目标追踪规则。根据预定义监控(MetricName)项动态计算需要扩缩容的 ECS 实例数量,尽量将预定义监控项的指标值维持在目标值(TargetValue)附近。
  • StepScalingRule:步进规则,根据阈值和指标值提供分步扩展方式。
  • PredictiveScalingRule:预测规则,基于机器学习能力分析伸缩组的历史监控数据预测未来监控指标值,并支持自动创建定时任务设置伸缩组边界。
SimpleScalingRule
ShowAlarmRulesboolean

是否返回伸缩规则关联的云监控报警任务。取值范围:

  • true:返回伸缩规则关联的云监控报警任务。
  • false:不返回伸缩规则关联的云监控报警任务。

默认值:false。

false
ScalingRuleIdsarray

待查询伸缩规则的 ID。

string

待查询伸缩规则的 ID。

asr-bp1dvirgwkoowxk7****
ScalingRuleNamesarray

待查询伸缩规则的名称。

string

待查询伸缩规则的名称。

scalingrule****
ScalingRuleArisarray

待查询伸缩规则的唯一标识符。

string

待查询伸缩规则的唯一标识符。

ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

当前页码。

1
PageSizeinteger

每页行数。

50
TotalCountinteger

伸缩规则总数。

1
ScalingRulesobject []

伸缩规则信息组成的集合。

MetricNamestring

伸缩规则关联的报警任务监控项名称。

CpuUtilization
AdjustmentTypestring

伸缩规则的调整方式。可能值:

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

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

100
EstimatedInstanceWarmupinteger

新创建的实例做一系列准备措施,即预热所需要的时间,在预热时间内,已启动的实例将不影响伸缩组的监控指标。

300
ScaleOutEvaluationCountinteger

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

3
PredictiveScalingModestring

预测规则的模式。可能值:

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

伸缩规则最小调整实例数,仅当伸缩规则类型为 SimpleScalingRule 或 StepScalingRule,且 AdjustmentType 为 PercentChangeInCapacity 时生效。

1
ScalingRuleAristring

伸缩规则的唯一标识符。

ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****
PredictiveTaskBufferTimeinteger

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

30
MinSizeinteger

伸缩组最小实例数。

1
ScalingGroupIdstring

伸缩组的 ID。

asg-bp1ffogfdauy0jw0****
PredictiveValueBehaviorstring

预测规则最大值处理方式。可能值:

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

目标值。当伸缩规则为目标追踪规则或预测规则时,该伸缩规则将通过添加或删除实例来将指标维持在目标值附近。

0.125
Cooldowninteger

伸缩规则的冷却时间,仅适用于简单规则。 取值范围:0~86400,单位:秒。

20
MaxSizeinteger

伸缩组最大实例数。

2
PredictiveValueBufferinteger

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

50
ScalingRuleTypestring

伸缩规则类型。可能值:

  • SimpleScalingRule:简单规则。根据调整方式(AdjustmentType)和调整值(AdjustmentValue)调整 ECS 实例数量。
  • TargetTrackingScalingRule:目标追踪规则。根据预定义监控(MetricName)项动态计算需要扩缩容的 ECS 实例数量,尽量将预定义监控项的指标值维持在目标值(TargetValue)附近。
  • StepScalingRule: 步进规则,根据阈值和指标值提供分步扩展方式。
  • PredictiveScalingRule:预测规则,基于机器学习能力分析伸缩组的历史监控数据预测未来监控指标值,并支持自动创建定时任务设置伸缩组边界。
SimpleScalingRule
AdjustmentValueinteger

伸缩规则的调整值。

1
ScaleInEvaluationCountinteger

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

15
DisableScaleInboolean

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

  • true:禁用缩容。
  • false:允许缩容。
true
ScalingRuleNamestring

伸缩规则的名称。

scalingrule****
ScalingRuleIdstring

伸缩规则的 ID。

asr-bp1dvirgwkoowxk7****
Alarmsobject []

伸缩规则关联的云监控报警任务。仅在 ShowAlarmRules 参数为 true 时返回伸缩规则关联的云监控报警任务,否则返回空列表。

AlarmTaskIdstring

伸缩规则关联的报警任务的 ID。

asg-bp18p2yfxow2dloq****_1f9458d1-70e1-4bee-8c7f-7a47695b****
ComparisonOperatorstring

伸缩规则关联的报警任务使用的监控项统计值与阈值的比较符,用于指定监控项统计值与阈值在什么关系下满足条件。可能值:

  • 监控项统计值大于等于阈值。取值:>=。
  • 监控项统计值小于等于阈值。取值:<=。
  • 监控项统计值大于阈值。取值:>。
  • 监控项统计值小于阈值。取值:<。
>=
MetricNamestring

伸缩规则关联的报警任务监控项名称。

CpuUtilization
EvaluationCountinteger

伸缩规则关联的报警任务到达报警状态需要连续满足阈值表达式的次数。

3
AlarmTaskNamestring

伸缩规则关联的报警任务的名称。

alarmtask****
MetricTypestring

伸缩规则关联的报警任务的类型。可能值:

  • system:系统监控报警任务。
  • custom:自定义监控报警任务。
system
Thresholdfloat

伸缩规则关联的报警任务的报警阈值。

50
Statisticsstring

伸缩规则关联的报警任务的统计方式。可能值:

  • Average:统计平均值。
  • Maximum:统计最大值。
  • Minimum:统计最小值。
Average
Dimensionsobject []

伸缩规则关联的报警任务的维度信息。

DimensionKeystring

监控项关联的维度信息键值。可能值:

  • scaling_group:伸缩组 ID。
  • userId:用户账号 ID。
scaling_group
DimensionValuestring

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

asg-bp18p2yfxow2dloq****
StepAdjustmentsobject []

步进规则的分步步骤。

MetricIntervalUpperBoundfloat

分步步骤的上边界,取值范围:-9.999999E18~9.999999E18。

5.0
ScalingAdjustmentinteger

分步步骤对应的实例扩展数量。

1
MetricIntervalLowerBoundfloat

分步步骤的下边界,取值范围:-9.999999E18~9.999999E18。

1.0
AlarmDimensionsobject []

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

DimensionKeystring

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

rulePool
DimensionValuestring

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

sgp-l1cbirz451yxu2****

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageNumber": 1,
  "PageSize": 50,
  "TotalCount": 1,
  "ScalingRules": [
    {
      "MetricName": "CpuUtilization",
      "AdjustmentType": "QuantityChangeInCapacity",
      "InitialMaxSize": 100,
      "EstimatedInstanceWarmup": 300,
      "ScaleOutEvaluationCount": 3,
      "PredictiveScalingMode": "PredictAndScale",
      "MinAdjustmentMagnitude": 1,
      "ScalingRuleAri": "ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****",
      "PredictiveTaskBufferTime": 30,
      "MinSize": 1,
      "ScalingGroupId": "asg-bp1ffogfdauy0jw0****",
      "PredictiveValueBehavior": "MaxOverridePredictiveValue",
      "TargetValue": 0.125,
      "Cooldown": 20,
      "MaxSize": 2,
      "PredictiveValueBuffer": 50,
      "ScalingRuleType": "SimpleScalingRule",
      "AdjustmentValue": 1,
      "ScaleInEvaluationCount": 15,
      "DisableScaleIn": true,
      "ScalingRuleName": "scalingrule****",
      "ScalingRuleId": "asr-bp1dvirgwkoowxk7****",
      "Alarms": [
        {
          "AlarmTaskId": "asg-bp18p2yfxow2dloq****_1f9458d1-70e1-4bee-8c7f-7a47695b****",
          "ComparisonOperator": ">=",
          "MetricName": "CpuUtilization",
          "EvaluationCount": 3,
          "AlarmTaskName": "alarmtask****",
          "MetricType": "system",
          "Threshold": 50,
          "Statistics": "Average",
          "Dimensions": [
            {
              "DimensionKey": "scaling_group",
              "DimensionValue": "asg-bp18p2yfxow2dloq****"
            }
          ]
        }
      ],
      "StepAdjustments": [
        {
          "MetricIntervalUpperBound": 5,
          "ScalingAdjustment": 1,
          "MetricIntervalLowerBound": 1
        }
      ],
      "AlarmDimensions": [
        {
          "DimensionKey": "rulePool",
          "DimensionValue": "sgp-l1cbirz451yxu2****"
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-04-03OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更