ModifyScalingRule - 修改一條伸縮規則

更新時間:
Copy as MD

建立伸縮規則後,如果當前伸縮規則不再滿足需求,您可以調用API ModifyScalingRule修改一項或多項伸縮規則屬性,無需重新建立新的伸縮規則,避免不必要的重複操作,節約時間和資源成本。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ess:ModifyScalingRule

update

*ScalingGroup

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

請求參數

名稱

類型

必填

描述

樣本值

ScalingRuleId

string

待修改伸縮規則的 ID。

asr-bp1dvirgwkoowxk7****

ScalingRuleName

string

伸縮規則的名稱,2~64 個英文或中文字元,以數字、大小字母或中文開頭,可包含數字、底線(_)、短劃線(-)或半形句號(.)。

同一使用者帳號同一地區同一伸縮組內伸縮規則唯一。

scalingrule****

Cooldown

integer

伸縮規則的冷卻時間,僅適用於簡單規則。

取值範圍:0~86400,單位:秒。

60

MinAdjustmentMagnitude

integer

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

1

AdjustmentType

string

伸縮規則的調整方式, 適用於簡單規則和步進規則,且此時該項必選。取值範圍:

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

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

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

QuantityChangeInCapacity

AdjustmentValue

integer

伸縮規則的調整值, 適用於簡單規則和步進規則,且此時該項必選。任何情況下,單次調整的 ECS 執行個體台數都不能超過 1000。不同調整方式對應的取值範圍:

  • QuantityChangeInCapacity:-1000~1000。

  • PercentChangeInCapacity:-100~10000。

  • TotalCapacity:0~2000。

100

EstimatedInstanceWarmup

integer

執行個體預熱時間,適用於目標追蹤規則和步進規則。處於預熱狀態的 ECS 執行個體將正常的加入伸縮組,但是期間將不會向CloudMonitor上報監控資料。

說明

動態計算需要擴縮容的 ECS 執行個體數量時,處於預熱狀態的執行個體不計入現有執行個體數量。

取值範圍:0~86400,單位:秒。

60

MetricName

string

預定義監控項,適用於目標追蹤規則和預測規則,且此時該項必選。

目標追蹤規則取值範圍:

  • 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

TargetValue

number

目標值,適用於目標追蹤規則和預測規則。TargetValue 最多保留小數點後三位,且必須大於 0。

0.125

DisableScaleIn

boolean

是否禁用縮容,僅適用於目標追蹤規則。

true

ScaleInEvaluationCount

integer

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

15

ScaleOutEvaluationCount

integer

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

3

PredictiveScalingMode

string

預測規則的模式。取值範圍:

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

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

PredictAndScale

PredictiveValueBehavior

string

預測規則最大值處理方式。取值範圍:

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

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

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

MaxOverridePredictiveValue

PredictiveValueBuffer

integer

PredictiveValueBehaviorPredictiveValueOverrideMaxWithBuffer時生效,預測值會按照該比例增加,當增加後的值大於初始最大值時,會採用增加後的值。取值範圍:0~100。

50

PredictiveTaskBufferTime

integer

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

30

InitialMaxSize

integer

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

100

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

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

DimensionKey

string

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

rulePool

DimensionValue

string

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

sgp-l1cbirz451yxu2dxxx

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

AlarmOptions

object

警示屬性定義。

Period

integer

目標追蹤規則中統計監控項資料的周期,單位:秒。取值範圍:

  • 15。

  • 60。

  • 120。

  • 300。

  • 900。

說明

預設值:60。

60

返回參數

名稱

類型

描述

樣本值

object

修改伸縮規則的返回資訊。

RequestId

string

請求 ID。

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

樣本

正常返回樣本

JSON格式

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

錯誤碼

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

變更歷史

更多資訊,參考變更詳情