幫助中心
首頁 Auto Scaling 開發參考 API參考 API參考（2022-02-22） API目錄 伸縮規則 DescribeScalingRules - 查詢伸縮規則

DescribeScalingRules - 查詢伸縮規則

更新時間：
Copy as MD
產品

調用DescribeScalingRules並指定伸縮規則ID、伸縮規則名稱、伸縮規則唯一識別碼等參數，查詢伸縮規則及其詳細資料。例如，伸縮規則的調整方式、執行個體預熱時間、伸縮規則關聯的警示任務資訊等。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

  • 操作：是指具體的許可權點。

  • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

  • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

    • 對於必選的資源類型，用前面加 * 表示。

    • 對於不支援資源級授權的操作，用全部資源表示。

  • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

  • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ess:DescribeScalingRules

get

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

 無 無

請求參數

名稱

類型

必填

描述

樣本值
RegionId

string

是

伸縮規則所屬伸縮組的地區 ID。

cn-qingdao
PageNumber

integer

否

伸縮規則列表的頁碼，起始值：1。

預設值：1。

1
PageSize

integer

否

分頁查詢時設定的每頁行數，最大值：50。

預設值：10。

50
ScalingGroupId

string

否

伸縮組的 ID。

asg-bp1ffogfdauy0jw0****
ScalingRuleType

string

否

伸縮規則的類型。取值範圍：

  • SimpleScalingRule：簡單規則。根據調整方式（AdjustmentType）和調整值（AdjustmentValue）調整 ECS 執行個體數量。

  • TargetTrackingScalingRule：目標追蹤規則。根據預定義監控（MetricName）項動態計算需要擴縮容的 ECS 執行個體數量，盡量將預定義監控項的指標值維持在目標值（TargetValue）附近。

  • StepScalingRule：步進規則，根據閾值和指標值提供分步擴充方式。

  • PredictiveScalingRule：預測規則，基於機器學習能力分析伸縮組的歷史監控資料預測未來監控指標值，並支援自動建立定時任務設定伸縮組邊界。

SimpleScalingRule
ShowAlarmRules

boolean

否

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

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

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

預設值：false。

false
ScalingRuleIds

array

否

待查詢伸縮規則的 ID。

string

否

待查詢伸縮規則的 ID。

asr-bp1dvirgwkoowxk7****
ScalingRuleNames

array

否

待查詢伸縮規則的名稱。

string

否

待查詢伸縮規則的名稱。

scalingrule****
ScalingRuleAris

array

否

待查詢伸縮規則的唯一識別碼。

string

否

待查詢伸縮規則的唯一識別碼。

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

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

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

integer

當前頁碼。

1
PageSize

integer

每頁行數。

50
TotalCount

integer

伸縮規則總數。

1
ScalingRules

array<object>

伸縮規則資訊組成的集合。

array<object>

伸縮規則資訊組成的集合。

MetricName

string

伸縮規則關聯的警示任務監控項名稱。

CpuUtilization
AdjustmentType

string

伸縮規則的調整方式。可能值：

  • QuantityChangeInCapacity：增加或減少指定數量的 ECS 執行個體。

  • PercentChangeInCapacity：增加或減少指定比例的 ECS 執行個體。

  • TotalCapacity： 將當前伸縮組的 ECS 執行個體數量調整到指定數量。

QuantityChangeInCapacity
InitialMaxSize

integer

伸縮組執行個體數的上限，和 PredictiveValueBehavior 結合使用。

100
EstimatedInstanceWarmup

integer

新建立的執行個體做一系列準備措施，即預熱所需要的時間，在預熱時間內，已啟動的執行個體將不影響伸縮組的監控指標。

300
ScaleOutEvaluationCount

integer

建立目標追蹤規則後，會自動建立警示任務。本參數用於指定對應的擴容警示任務觸發警示時，所需連續滿足閾值條件的次數。

3
PredictiveScalingMode

string

預測規則的模式。可能值：

  • PredictAndScale：產生預測結果並建立預測任務。

  • PredictOnly：產生預測結果，但不會建立預測任務。

PredictAndScale
MinAdjustmentMagnitude

integer

伸縮規則最小調整執行個體數，僅當伸縮規則類型為 SimpleScalingRule 或 StepScalingRule，且 AdjustmentType 為 PercentChangeInCapacity 時生效。

1
ScalingRuleAri

string

伸縮規則的唯一識別碼。

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

integer

預測規則自動建立的預測任務預設均在整點執行，您可以設定開機前時間提前執行預測任務，預先準備資源。取值範圍：0~60，單位：分鐘。

30
MinSize

integer

伸縮組最小執行個體數。

1
ScalingGroupId

string

伸縮組的 ID。

asg-bp1ffogfdauy0jw0****
PredictiveValueBehavior

string

預測規則最大值處理方式。可能值：

  • MaxOverridePredictiveValue：初始最大值會覆蓋預測值。預測值大於初始最大值時，預測任務的最大值採用初始最大值。

  • PredictiveValueOverrideMax：預測值會覆蓋初始最大值。預測值大於初始最大值時， 預測任務的最大值採用預測值。

  • PredictiveValueOverrideMaxWithBuffer：預測值會附加一定比例。預測值會按照 PredictiveValueBuffer 比例增加，當增加後的值大於初始最大值時，會採用增加後的值。

MaxOverridePredictiveValue
TargetValue

number

目標值。當伸縮規則為目標追蹤規則或預測規則時，該伸縮規則將通過添加或刪除執行個體來將指標維持在目標值附近。

0.125
Cooldown

integer

伸縮規則的冷卻時間，僅適用於簡單規則。 取值範圍：0~86400，單位：秒。

20
MaxSize

integer

伸縮組最大執行個體數。

2
PredictiveValueBuffer

integer

PredictiveValueBehavior 為 PredictiveValueOverrideMaxWithBuffer 時生效，預測值會按照該比例增加，當增加後的值大於初始最大值時，會採用增加後的值。取值範圍：0~100。

50
ScalingRuleType

string

伸縮規則類型。可能值：

  • SimpleScalingRule：簡單規則。根據調整方式（AdjustmentType）和調整值（AdjustmentValue）調整 ECS 執行個體數量。

  • TargetTrackingScalingRule：目標追蹤規則。根據預定義監控（MetricName）項動態計算需要擴縮容的 ECS 執行個體數量，盡量將預定義監控項的指標值維持在目標值（TargetValue）附近。

  • StepScalingRule： 步進規則，根據閾值和指標值提供分步擴充方式。

  • PredictiveScalingRule：預測規則，基於機器學習能力分析伸縮組的歷史監控資料預測未來監控指標值，並支援自動建立定時任務設定伸縮組邊界。

SimpleScalingRule
AdjustmentValue

integer

伸縮規則的調整值。

1
ScaleInEvaluationCount

integer

建立目標追蹤規則後，會自動建立警示任務。本參數用於指定對應的縮容警示任務觸發警示時，所需連續滿足閾值條件的次數。

15
DisableScaleIn

boolean

是否禁用縮容，僅適用於目標追蹤規則。可能值：

  • true：禁用縮容。

  • false：允許縮容。

true
ScalingRuleName

string

伸縮規則的名稱。

scalingrule****
ScalingRuleId

string

伸縮規則的 ID。

asr-bp1dvirgwkoowxk7****
Alarms

array<object>

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

array<object>

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

AlarmTaskId

string

伸縮規則關聯的警示任務的 ID。

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

string

伸縮規則關聯的警示任務使用的監控項統計值與閾值的比較符，用於指定監控項統計值與閾值在什麼關係下滿足條件。可能值：

  • 監控項統計值大於等於閾值。取值：>=。

  • 監控項統計值小於等於閾值。取值：<=。

  • 監控項統計值大於閾值。取值：>。

  • 監控項統計值小於閾值。取值：<。

>=
MetricName

string

伸縮規則關聯的警示任務監控項名稱。

CpuUtilization
EvaluationCount

integer

伸縮規則關聯的警示任務到達警示狀態需要連續滿足閾值運算式的次數。

3
AlarmTaskName

string

伸縮規則關聯的警示任務的名稱。

alarmtask****
MetricType

string

伸縮規則關聯的警示任務的類型。可能值：

  • system：系統監控警示任務。

  • custom：自訂監控警示任務。

system
Threshold

number

伸縮規則關聯的警示任務的警示閾值。

50
Statistics

string

伸縮規則關聯的警示任務的統計方式。可能值：

  • Average：統計平均值。

  • Maximum：統計最大值。

  • Minimum：統計最小值。

Average
Dimensions

array<object>

伸縮規則關聯的警示任務的維度資訊。

object

伸縮規則關聯的警示任務的維度資訊。

DimensionKey

string

監控項關聯的維度資訊索引值。可能值：

  • scaling_group：伸縮組 ID。

  • userId：使用者帳號 ID。

scaling_group
DimensionValue

string

監控項關聯的維度資訊屬性值。

asg-bp18p2yfxow2dloq****
Period

integer

目標追蹤規則中統計監控項資料的周期。

60
StepAdjustments

array<object>

步進規則的分步步驟。

object

步進規則的分步步驟。

MetricIntervalUpperBound

number

分步步驟的上邊界，取值範圍：-9.999999E18~9.999999E18。

5.0
ScalingAdjustment

integer

分步步驟對應的執行個體擴充數量。

1
MetricIntervalLowerBound

number

分步步驟的下邊界，取值範圍：-9.999999E18~9.999999E18。

1.0
AlarmDimensions

array<object>

監控項維度資訊值，適用於目標追蹤規則，當監控項需額外維度資訊時設定，例如 LoadBalancerRealServerAverageQps 監控項需指定 rulePool 維度資訊。

object

DimensionKey

string

監控項關聯的維度資訊鍵。

rulePool
DimensionValue

string

監控項關聯的維度資訊值。

sgp-l1cbirz451yxu2****
MetricType

string

監控項類型。可能值：

  • system：使用CloudMonitor系統指標。

  • custom：使用上報到CloudMonitor的自訂指標。

  • hybrid：使用企業CloudMonitor的指標。

system
HybridMonitorNamespace

string

企業CloudMonitor指標倉庫 id。

管理指標倉庫，請參見管理指標倉庫。

aliyun-test
HybridMetrics

array<object>

企業CloudMonitor指標設定。如何設定，請參見使用公式運算自訂目標追蹤規則。

array<object>

Id

string

公制運算運算式中指標的引用 id。

a
Expression

string

多個企業CloudMonitor指標的公制運算運算式，運算式的計算結果將用於觸發擴縮容。

運算運算式需滿足逆波蘭運算式（RPN）規範，並且操作符只支援+ - * /。

(a+b)/2
MetricName

string

企業CloudMonitor指標倉庫中的指標名稱。

AliyunSmq_NumberOfMessagesVisible
Statistic

string

指標的統計方式。可能值：

  • Average：指定區間內所有點的平均值。

  • Minimum：指定區間內所有點的最小值。

  • Maximum：指定區間內所有點的最大值。

Average
Dimensions

array<object>

指標緯度。用於指定指標監控的資源。

object

DimensionKey

string

指標維度 key。

queue
DimensionValue

string

指標維度 value。

testQueue

樣本

正常返回樣本

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****"
            }
          ],
          "Period": 60
        }
      ],
      "StepAdjustments": [
        {
          "MetricIntervalUpperBound": 5,
          "ScalingAdjustment": 1,
          "MetricIntervalLowerBound": 1
        }
      ],
      "AlarmDimensions": [
        {
          "DimensionKey": "rulePool",
          "DimensionValue": "sgp-l1cbirz451yxu2****"
        }
      ],
      "MetricType": "system",
      "HybridMonitorNamespace": "aliyun-test",
      "HybridMetrics": [
        {
          "Id": "a",
          "Expression": "(a+b)/2",
          "MetricName": "AliyunSmq_NumberOfMessagesVisible",
          "Statistic": "Average",
          "Dimensions": [
            {
              "DimensionKey": "queue",
              "DimensionValue": "testQueue"
            }
          ]
        }
      ]
    }
  ]
}

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。

上一篇：ModifyScalingRule - 修改一條伸縮規則下一篇：DeleteScalingRule - 刪除一條伸縮規則