AI 助理
备案控制台
文档
输入文档关键字查找
首页 弹性伸缩 开发参考 API参考 API参考（2014-08-28） 伸缩规则 DescribeScalingRules

DescribeScalingRules

更新时间：
产品详情
我的收藏

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述
Action String 是 DescribeScalingRules

系统规定参数。取值：DescribeScalingRules。
RegionId String 是 cn-qingdao

伸缩规则所属伸缩组的地域ID。
PageNumber Integer 否 1

伸缩规则列表的页码，起始值：1。

默认值：1
PageSize Integer 否 50

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

默认值：10。
ScalingGroupId String 否 asg-bp1ffogfdauy0jw0****

伸缩组的ID。
ScalingRuleType String 否 SimpleScalingRule

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

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

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

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

默认值：false。
ScalingRuleId.N String 否 asr-bp1dvirgwkoowxk7****

ScalingRuleId.N为待查询伸缩规则的ID，N的取值范围：1～10。
ScalingRuleName.N String 否 scalingrule****

ScalingRuleName.N为待查询伸缩规则的名称，N的取值范围：1～10。
ScalingRuleAri.N String 否 ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****

ScalingRuleAri.N为待查询伸缩规则的唯一标识符，N的取值范围：1～10。

返回数据

名称

类型

示例值

描述
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

请求ID。
PageNumber Integer 1

当前页码。
PageSize Integer 50

每页行数。
TotalCount Integer 1

伸缩规则总数。
ScalingRules Array of ScalingRule

伸缩规则信息组成的集合。
ScalingRule
MetricName String CpuUtilization

预定义监控项，适用于目标追踪规则和预测规则。

目标追踪伸缩规则的可能值：

  • CpuUtilization：平均CPU使用率。
  • ClassicInternetRx：经典网络公网入流量平均值。
  • ClassicInternetTx：经典网络公网出流量平均值。
  • VpcInternetRx：VPC网络公网入流量平均值。
  • VpcInternetTx：VPC网络公网出流量平均值。
  • IntranetRx：内网入流量平均值。

  • IntranetTx：内网出流量平均值。

    预测规则的可能值：

  • CpuUtilization：平均CPU使用率。
  • IntranetRx：内网入流量平均值。
  • IntranetTx：内网出流量平均值。
AdjustmentType String QuantityChangeInCapacity

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

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

伸缩组实例数的上限，和PredictiveValueBehavior结合使用。
EstimatedInstanceWarmup Integer 300

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

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

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

  • PredictAndScale：产生预测结果并创建预测任务。
  • PredictOnly：产生预测结果，但不会创建预测任务。
MinAdjustmentMagnitude Integer 1

伸缩规则最小调整实例数，仅当伸缩规则类型为SimpleScalingRule或StepScalingRule，且AdjustmentType为PercentChangeInCapacity时生效。
ScalingRuleAri String ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****

伸缩规则的唯一标识符。
PredictiveTaskBufferTime Integer 30

预测规则自动创建的预测任务默认均在整点执行，您可以设置预启动时间提前执行预测任务，预先准备资源。可能值：0~60，单位：分钟。
MinSize Integer 1

伸缩组最小实例数。
ScalingGroupId String asg-bp1ffogfdauy0jw0****

伸缩组的ID。
PredictiveValueBehavior String MaxOverridePredictiveValue

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

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

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

伸缩规则的冷却时间，仅适用于简单规则。可能值：0~86400，单位：秒。
MaxSize Integer 2

伸缩组最大实例数。
PredictiveValueBuffer Integer 50

PredictiveValueBehavior为PredictiveValueOverrideMaxWithBuffer时生效，预测值会按照该比例增加，当增加后的值大于初始最大值时，会采用增加后的值。可能值：0~100。
ScalingRuleType String SimpleScalingRule

伸缩规则类型。可能值：

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

伸缩规则的调整值。
ScaleInEvaluationCount Integer 15

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

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

  • true：禁用缩容。
  • false：允许缩容。
ScalingRuleName String scalingrule****

伸缩规则的名称。
ScalingRuleId String asr-bp1dvirgwkoowxk7****

伸缩规则的ID。
Alarms Array of Alarm

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

Alarm
AlarmTaskId String asg-bp18p2yfxow2dloq****_1f9458d1-70e1-4bee-8c7f-7a47695b****

伸缩规则关联的报警任务的ID。
ComparisonOperator String >=

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

  • 监控项统计值大于等于阈值。取值：>=。
  • 监控项统计值小于等于阈值。取值：<=。
  • 监控项统计值大于阈值。取值：>。
  • 监控项统计值小于阈值。取值：<。
MetricName String CpuUtilization

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

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

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

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

  • system：系统监控报警任务。
  • custom：自定义监控报警任务。
Threshold Float 50

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

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

  • Average：统计平均值。
  • Maximum：统计最大值。
  • Minimum：统计最小值。
Dimensions Array of Dimension

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

监控项关联的报警任务的维度信息键。可能值：

  • scaling_group：伸缩组ID。
  • userId：用户账号ID。
DimensionValue String asg-bp18p2yfxow2dloq****

监控项关联的报警任务的维度信息值。
StepAdjustments Array of StepAdjustment

步进规则的分步步骤。
StepAdjustment
MetricIntervalUpperBound Float 5.0

分步步骤的上边界，可能值：-9.999999E18~9.999999E18。
ScalingAdjustment Integer 1

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

分步步骤的下边界，可能值：-9.999999E18~9.999999E18。
AlarmDimensions Array of AlarmDimension

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

监控项关联的维度信息键。
DimensionValue String sgp-l1cbirz451yxu2****

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

示例

请求示例

http(s)://ess.aliyuncs.com/?Action=DescribeScalingRules
&RegionId=cn-qingdao
&PageNumber=1
&PageSize=50
&ScalingGroupId=asg-bp1ffogfdauy0jw0****
&ScalingRuleType=SimpleScalingRule
&ShowAlarmRules=false
&ScalingRuleId=["asr-bp1dvirgwkoowxk7****"]
&ScalingRuleName=["scalingrule****"]
&ScalingRuleAri=["ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****"]
&公共请求参数

正常返回示例

XML格式

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

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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****"
    } ]
  } ]
}

错误码

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

上一篇：CreateScalingRule下一篇：ModifyScalingRule
文档推荐