全部產品
Search

搜尋本產品

    Auto Scaling：DescribeScalingRules

    文件中心

    Auto Scaling：DescribeScalingRules

    更新時間：Jan 14, 2025

    調用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

    是否返回伸縮規則關聯的CloudMonitor警示任務。取值範圍：

    • true：返回伸縮規則關聯的CloudMonitor警示任務。
    • false：不返回伸縮規則關聯的CloudMonitor警示任務。

    預設值：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

    伸縮規則關聯的CloudMonitor警示任務。僅在ShowAlarmRules參數為true時返回伸縮規則關聯的CloudMonitor警示任務，否則返回空列表。

    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****"
    } ]
  } ]
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。