CreateScalingRule - Auto Scaling

建立一條伸縮規則。

介面說明

請注意以下參數相關說明：

當 AdjustmentType 是 TotalCapacity 時，表示將目前伸縮群組的 ECS 或 ECI 執行個體數量調整到指定數量，對應的 AdjustmentValue 值必須大於等於 0。
當 AdjustmentType 是 QuantityChangeInCapacity 或 PercentChangeInCapacity，對應的 AdjustmentValue 值為正數表示增加執行個體、為負數表示減少執行個體。
當 AdjustmentType 是 PercentChangeInCapacity，彈性伸縮服務以伸縮群組目前執行個體數（Total Capacity）xAdjusmentValue/100，並使用四捨五入原則來確認增加或減少的 ECS 執行個體或 ECI 執行個體個數。
當伸縮規則指定了冷卻時間（Cooldown），則執行該伸縮規則的伸縮活動完成後，會以伸縮規則中指定的冷卻時間對伸縮群組進行冷卻處理，如果伸縮規則未指定冷卻時間，則以伸縮群組指定的冷卻時間（DefaultCooldown）為準。
一個伸縮群組內可以建立的伸縮規則數量有限，具體說明請參見使用限制。
傳回的伸縮規則唯一識別碼（ScalingRuleAri）可以供以下介面使用：
- 在執行伸縮規則（ExecuteScalingRule）的 ScalingRuleAri 參數中指定，您可以手動執行該伸縮規則。
- 在建立排程任務（CreateScheduledTask）的 ScheduledAction 參數中指定，使用者可以排程執行該伸縮規則。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ess:CreateScalingRule

create

*ScalingGroup

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

無

請求參數

名稱	類型	必填	描述	樣本值
ScalingGroupId	string	是	伸縮規則所屬伸縮群組的 ID。	asg-bp1ffogfdauy0jw0****
ScalingRuleName	string	否	伸縮規則的名稱。由 2~64 個字元組成，以數字、大小寫字母或中文開頭，可包含數字、底線（_）、短劃線（-）或半形句號（.）。同一使用者帳號同一地域同一伸縮群組內伸縮規則唯一。說明如果沒有指定該參數，預設值為 ScalingRuleId 的值。	scalingrule****
Cooldown	integer	否	伸縮規則的冷卻時間，僅適用於簡單規則。取值範圍：0~86400，單位：秒。預設值：空。	60
MinAdjustmentMagnitude	integer	否	伸縮規則最小調整執行個體數。僅當伸縮規則類型為`SimpleScalingRule`或`StepScalingRule`，且`AdjustmentType`為`PercentChangeInCapacity`時生效。	1
AdjustmentType	string	否	伸縮規則的調整方式，適用於簡單規則和步進規則，且此時該項必選。取值範圍： QuantityChangeInCapacity：增加或減少指定數量的 ECS 執行個體。 PercentChangeInCapacity：增加或減少指定比例的 ECS 執行個體。 TotalCapacity：將目前伸縮群組的 ECS 執行個體數量調整到指定數量。	QuantityChangeInCapacity
AdjustmentValue	integer	否	伸縮規則的調整值，適用於簡單規則和步進規則，且此時該項必選。任何情況下，單次調整的 ECS 執行個體數量都不能超過 1000。不同調整方式對應的取值範圍： QuantityChangeInCapacity：-1000~1000。 PercentChangeInCapacity：-100~10000。 TotalCapacity：0~2000。	100
ScalingRuleType	string	否	伸縮規則類型。取值範圍： SimpleScalingRule：簡單規則。根據調整方式（AdjustmentType）和調整值（AdjustmentValue）調整 ECS 或 ECI 執行個體數量。 TargetTrackingScalingRule：目標追蹤規則。根據預先定義監控（MetricName）指標動態計算需要擴縮容的 ECS 或 ECI 執行個體數量，盡量將預先定義監控指標的指標值維持在目標值（TargetValue）附近。 StepScalingRule：步進規則，根據臨界值和指標值提供分步擴充方式。 PredictiveScalingRule：預測規則，基於機器學習能力分析伸縮群組的歷史監控資料預測未來監控指標值，並支援自動建立排程任務設定伸縮群組邊界。預設值：SimpleScalingRule。	SimpleScalingRule
EstimatedInstanceWarmup	integer	否	執行個體預熱時間，適用於目標追蹤規則和步進規則。處於預熱狀態的 ECS 執行個體將正常的加入伸縮群組，但是期間將不會向雲端監控上報監控資料。說明動態計算需要擴縮容的 ECS 執行個體數量時，處於預熱狀態的執行個體不計入現有執行個體數量。取值範圍：0~86400，單位：秒。預設值：300。	300
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	否	是否停用縮容，僅適用於目標追蹤規則。預設值：false。	false
ScaleInEvaluationCount	integer	否	建立目標追蹤規則後，會自動建立警報任務。本參數用於指定對應的縮容警報任務觸發警報時，所需連續滿足臨界值條件的次數。預設值：15。	15
ScaleOutEvaluationCount	integer	否	建立目標追蹤規則後，會自動建立警報任務。本參數用於指定對應的擴容警報任務觸發警報時，所需連續滿足臨界值條件的次數。預設值：3。	3
PredictiveScalingMode	string	否	預測規則的模式，取值範圍： PredictAndScale：產生預測結果並建立預測任務。 PredictOnly：產生預測結果，但不會建立預測任務。預設值：PredictAndScale。	PredictAndScale
PredictiveValueBehavior	string	否	預測規則最大值處理方式，取值範圍： MaxOverridePredictiveValue：初始最大值會覆蓋預測值。預測值大於初始最大值時，預測任務的最大值採用初始最大值。 PredictiveValueOverrideMax：預測值會覆蓋初始最大值。預測值大於初始最大值時，預測任務的最大值採用預測值。 PredictiveValueOverrideMaxWithBuffer：預測值會附加一定比例。預測值會按照 PredictiveValueBuffer 比例增加，當增加後的值大於初始最大值時，會採用增加後的值。預設值：MaxOverridePredictiveValue。	MaxOverridePredictiveValue
PredictiveValueBuffer	integer	否	`PredictiveValueBehavior`為`PredictiveValueOverrideMaxWithBuffer`時生效，預測值會按照該比例增加，當增加後的值大於初始最大值時，會採用增加後的值。取值範圍：0~100。預設值：0。	50
PredictiveTaskBufferTime	integer	否	預測規則自動建立的預測任務預設均在整點執行，您可以設定預啟動時間提前執行預測任務，預先準備資源。取值範圍：0~60，單位：分鐘。預設值：0。	30
InitialMaxSize	integer	否	伸縮群組執行個體數上限，和 PredictiveValueBehavior 結合使用。預設值為伸縮群組最大執行個體數（MaxSize 的值）。	100
StepAdjustment	array<object>	否	分步步驟對應的執行個體擴充資訊組成的集合。
	object	否	分步步驟對應的執行個體擴充資訊組成的集合。
MetricIntervalUpperBound	number	否	分步步驟的上邊界，僅適用於步進規則，取值範圍：-9.999999E18~9.999999E18。	5.0
ScalingAdjustment	integer	否	分步步驟對應的執行個體擴充數量，僅適用於步進規則。	1
MetricIntervalLowerBound	number	否	分步步驟的下邊界，僅適用於步進規則，取值範圍：-9.999999E18~9.999999E18。	1.0
RegionId	string	否	伸縮群組所屬的地域 ID。	cn-hangzhou
AlarmDimension	array<object>	否	監控指標關聯的維度資訊，適用於目標追蹤規則，當監控指標需額外維度資訊時設定，例如`LoadBalancerRealServerAverageQps`監控指標需指定`rulePool`維度資訊。
	object	否	監控指標關聯的維度資訊，適用於目標追蹤規則，當監控指標需額外維度資訊時設定，例如`LoadBalancerRealServerAverageQps`監控指標需指定`rulePool`維度資訊。
DimensionKey	string	否	監控指標關聯的維度資訊鍵。	rulePool
DimensionValue	string	否	監控指標關聯的維度資訊值。	sgp-l1cbirz451yxu2****
MetricType	string	否	監控指標類型。取值範圍： system：使用雲端監控系統指標。 custom：使用上報到雲端監控的自訂指標。 hybrid：使用企業雲端監控的指標。	system
HybridMonitorNamespace	string	否	企業雲端監控指標倉庫 ID。管理指標倉庫，請參見管理指標倉庫。	aliyun-test
HybridMetrics	array<object>	否	企業雲端監控指標設定。如何設定，請參見使用公式運算自訂目標追蹤規則。
	array<object>	否
Id	string	否	指標運算運算式中指標的引用 ID。	a
Expression	string	否	多個企業雲端監控指標的指標運算運算式，運算式的計算結果將用於觸發擴縮容。運算運算式需滿足逆波蘭運算式（RPN）規範，並且運算子只支援`+ - * /`。	(a+b)/2
MetricName	string	否	企業雲端監控指標倉庫中的指標名稱。	AliyunSmq_NumberOfMessagesVisible
Statistic	string	否	指標的統計方式。取值範圍： Average：指定區間內所有點的平均值。 Minimum：指定區間內所有點的最小值。 Maximum：指定區間內所有點的最大值。	Average
Dimensions	array<object>	否	指標維度。用於指定指標監控的資源。
	object	否
DimensionKey	string	否	指標維度鍵。	queue
DimensionValue	string	否	指標維度值。	testQueue
AlarmOptions	object	否	警報屬性定義。
Period	integer	否	目標追蹤規則中統計監控指標資料的週期，單位：秒。取值範圍： 15。 60。 120。 300。 900。說明預設值：60。	60

返回參數

名稱	類型	描述	樣本值
	object
ScalingRuleAri	string	伸縮規則的唯一識別碼。	ari:acs:ess:cn-hangzhou:140692647406**:scalingrule/asr-bp1dvirgwkoowxk7**
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
ScalingRuleId	string	伸縮規則的 ID，由系統產生，全域唯一。	asr-bp1dvirgwkoowxk7****

樣本

正常返回樣本

JSON格式

{
  "ScalingRuleAri": "ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "ScalingRuleId": "asr-bp1dvirgwkoowxk7****"
}

錯誤碼

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

變更歷史

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