如果您需要根據業務變動需求與策略自動增加或減少指定類型的執行個體數量,則可以透過設定伸縮群組來自動調整您的業務運算能力(即執行個體數量)。如果目前伸縮群組屬性不再滿足業務需求,則您可以呼叫 API ModifyScalingGroup 修改伸縮群組屬性(例如最大執行個體數、最小執行個體數或期望執行個體數等屬性),避免重新建立伸縮群組並重新設定相關屬性,節省了時間和資源成本。
介面說明
-
不支援修改以下參數:
-
RegionId。
-
LoadBalancerId。
說明如果需要修改負載平衡執行個體,請使用 AttachLoadBalancers 和 DetachLoadBalancers 介面。
DBInstanceId。
說明如果需要修改 RDS 執行個體,請使用 AttachDBInstances 和 DetachDBInstances 介面。
-
-
當伸縮群組的狀態為
Active或Inactive時才能呼叫該介面。 -
啟用新的伸縮設定不會影響透過早前伸縮設定建立並正在執行的 ECS 執行個體或 ECI 執行個體。
-
如果修改了 MaxSize,導致目前伸縮群組的 ECS 或 ECI 執行個體數超過 MaxSize,則伸縮群組會自動移出 ECS 執行個體或 ECI 執行個體,使得伸縮群組的 ECS 或 ECI 執行個體數等於 MaxSize。
-
如果伸縮群組修改了 MinSize,導致目前伸縮群組的 ECS 或 ECI 執行個體數低於 MinSize,則伸縮群組會自動加入 ECS 執行個體或 ECI 執行個體,使得伸縮群組的 ECS 或 ECI 執行個體數等於 MinSize。
-
如果伸縮群組設定了 DesiredCapacity 時,修改了 DesiredCapacity,導致目前伸縮群組的 ECS 或 ECI 執行個體數與 DesiredCapacity 不一致,則伸縮群組會自動加入或移除 ECS 執行個體或 ECI 執行個體,使得伸縮群組的 ECS 或 ECI 執行個體數等於 DesiredCapacity。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ess:ModifyScalingGroup |
update |
*ScalingGroup
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ScalingGroupId |
string |
是 |
待修改伸縮群組的 ID。 |
asg-bp1ffogfdauy0jw0**** |
| ScalingGroupName |
string |
否 |
伸縮群組的名稱,同一地域下伸縮群組名稱唯一。長度為 2~64 個字元,以數字、大小英文字母或中文開頭,可以包含數字、底線(_)、短橫線(-)和半形句號(.)。 |
scalinggroup**** |
| MinSize |
integer |
否 |
伸縮群組內 ECS 執行個體或 ECI 執行個體台數的最小值,當伸縮群組內 ECS 或 ECI 執行個體數小於 MinSize 時,彈性伸縮會自動建立 ECS 執行個體或 ECI 執行個體。 說明
MinSize 的值必須小於或等於 MaxSize 的值。 |
1 |
| MaxSize |
integer |
否 |
伸縮群組內 ECS 執行個體或 ECI 執行個體台數的最大值,當伸縮群組內 ECS 或 ECI 執行個體數大於 MaxSize 時,彈性伸縮會自動移出 ECS 執行個體或 ECI 執行個體。 MaxSize 的取值範圍和彈性伸縮使用情況有關,請前往配額中心查看單個伸縮群組可以設定的群組內最大執行個體數對應的配額值。 例如,如果單個伸縮群組可以設定的群組內最大執行個體數對應的配額值為 2000,則 MaxSize 的取值範圍為 0~2000。 |
99 |
| DefaultCooldown |
integer |
否 |
伸縮群組預設的冷卻時間,僅適用於簡單規則。取值範圍:0~86400,單位:秒。 冷卻時間內,該伸縮群組不執行其他的伸縮活動,僅針對雲端監控警報任務觸發的伸縮活動有效。 |
600 |
| RemovalPolicies |
array |
否 |
指定移出 ECS 執行個體的伸縮群組策略。取值範圍:
|
|
|
string |
否 |
指定移出 ECS 執行個體的伸縮群組策略。取值範圍:
|
NewestInstance |
|
| ActiveScalingConfigurationId |
string |
否 |
伸縮群組內生效的伸縮設定的 ID。 |
asc-bp17pelvl720x5ub**** |
| HealthCheckType |
string |
否 |
伸縮群組的健康檢查方式。取值範圍:
說明
如果需要同時開啟執行個體健康檢查和負載平衡健康檢查,請使用 |
ECS |
| LaunchTemplateId |
string |
否 |
執行個體啟動範本 ID,用於指定伸縮群組從執行個體啟動範本取得啟動設定資訊。 |
lt-m5e3ofjr1zn1aw7**** |
| LaunchTemplateVersion |
string |
否 |
執行個體啟動範本的版本。取值範圍:
|
Default |
| OnDemandBaseCapacity |
integer |
否 |
伸縮群組所需要隨收隨付執行個體個數的最小值,取值範圍:0~1000。當隨收隨付執行個體個數少於該值時,將優先建立隨收隨付執行個體。 當 |
30 |
| OnDemandPercentageAboveBaseCapacity |
integer |
否 |
伸縮群組滿足最小隨收隨付執行個體數(OnDemandBaseCapacity)要求後,超出的執行個體中隨收隨付執行個體應佔的比例,取值範圍:0~100。 當 |
20 |
| SpotInstanceRemedy |
boolean |
否 |
是否開啟補齊搶佔式執行個體。開啟後,當收到搶佔式執行個體將被回收的系統訊息時,伸縮群組將嘗試建立新的執行個體,替換掉將被回收的搶佔式執行個體。 |
true |
| CompensateWithOnDemand |
boolean |
否 |
當
|
true |
| SpotInstancePools |
integer |
否 |
指定可用執行個體規格的個數,伸縮群組將按成本最低的多個規格均衡建立搶佔式執行個體。取值範圍:0~10。 當 |
5 |
| DesiredCapacity |
integer |
否 |
伸縮群組內 ECS 執行個體或 ECI 執行個體的期望數量,伸縮群組會自動將 ECS 執行個體或 ECI 執行個體數量維持在期望執行個體數。取值範圍:MaxSize≥期望執行個體數量≥MinSize。 說明
如果期望執行個體數功能關閉後又重新開啟,則您需要重新設定 |
5 |
| GroupDeletionProtection |
boolean |
否 |
是否開啟伸縮群組刪除保護。取值範圍:
|
true |
| MultiAZPolicy |
string |
否 |
多可用區伸縮群組 ECS 執行個體擴縮容策略。取值範圍:
說明
|
PRIORITY |
| VSwitchIds |
array |
否 |
一台或多台虛擬交換器的 ID。 只有當伸縮群組網路類型為 VPC 時,目前參數才生效。指定虛擬交換器所屬的 VPC 必須和伸縮群組所屬的 VPC 相同。 虛擬交換器可以來自多個可用區。虛擬交換器的優先順序按照數字升序排序,1 表示最高優先順序。當優先順序較高的虛擬交換器所在可用區無法建立 ECS 執行個體時,自動選擇下一優先順序的虛擬交換器建立 ECS 執行個體。 |
|
|
string |
否 |
一台或多台虛擬交換器的 ID。 只有當伸縮群組網路類型為 VPC 時,目前參數才生效。指定虛擬交換器所屬的 VPC 必須和伸縮群組所屬的 VPC 相同。 虛擬交換器可以來自多個可用區。虛擬交換器的優先順序按照數字升序排序,1 表示最高優先順序。當優先順序較高的虛擬交換器所在可用區無法建立 ECS 執行個體時,自動選擇下一優先順序的虛擬交換器建立 ECS 執行個體。 |
vsw-bp1oo2a7isyrb8igf**** |
|
| LaunchTemplateOverrides |
array<object> |
否 |
擴充啟動範本的執行個體規格資訊。 |
|
|
object |
否 |
擴充啟動範本的執行個體規格資訊。 |
||
| InstanceType |
string |
否 |
當您需要伸縮群組按照執行個體規格容量進行伸縮時,請同時指定本參數和 LaunchTemplateOverrides.WeightedCapacity。 本參數用於指定執行個體規格,會覆蓋啟動範本中的執行個體規格。 說明
僅當 LaunchTemplateId 參數指定了啟動範本時,本參數生效。 InstanceType 的取值範圍:在售的 ECS 執行個體規格。 |
ecs.c5.xlarge |
| WeightedCapacity |
integer |
否 |
當您需要伸縮群組按照執行個體規格容量進行伸縮時,在指定 LaunchTemplateOverrides.InstanceType 後,再指定本參數。兩個參數一一對應。 本參數用於指定執行個體規格的權重,即執行個體規格的單台執行個體在伸縮群組中表示的容量大小。 權重越大,滿足期望容量所需的本執行個體規格的執行個體數量越少。 由於每個執行個體規格的 vCPU 個數、記憶體大小等效能指標會有差異,您可以根據自身需求,給不同的執行個體規格設定不同的權重。 例如:
為滿足期望容量,伸縮群組將為使用者擴容 2 台 ecs.c5.xlarge 執行個體。 說明
擴容時伸縮群組的容量不得超過最大容量(MaxSize)與執行個體規格的最大權重之和。 WeightedCapacity 的取值範圍:1~500。 |
4 |
| SpotPriceLimit |
number |
否 |
本參數用於指定執行個體啟動範本覆蓋規格(即 說明
僅當 |
0.025 |
| MaxInstanceLifetime |
integer |
否 |
執行個體在伸縮群組中存活的最大時間。單位為秒。 取值範圍:0 或 預設值:null。 說明
ECI 類型的伸縮群組或停機不收費的伸縮群組不支援設定該參數。 |
86400 |
| AzBalance |
boolean |
否 |
伸縮群組的容量是否在各個可用區間均衡分佈(僅當
預設值:false。 |
false |
| AllocationStrategy |
string |
否 |
容量分配策略,決定了伸縮群組如何選擇可用的執行個體規格類型滿足容量。容量分佈策略同時對隨收隨付和搶佔式容量生效(僅當 MultiAZPolicy 參數取值為 COMPOSABLE 策略時生效)。取值範圍:
預設值:priority。 |
priority |
| SpotAllocationStrategy |
string |
否 |
搶佔式容量分佈策略。您可以透過該參數單獨指定搶佔式容量的分佈策略(僅當
預設值:priority。 |
lowestPrice |
| CustomPolicyARN |
string |
否 |
自訂縮容策略 Function 函式 ARN。僅當 RemovalPolicies 設定第一個移除策略為 CustomPolicy 時生效。 |
acs:fc:cn-zhangjiakou:16145688****:services/ess_custom_terminate_policy.LATEST/functions/ess_custom_terminate_policy_name |
| DisableDesiredCapacity |
boolean |
否 |
伸縮群組是否關閉期望執行個體數功能。取值範圍:
說明
只有伸縮群組目前無伸縮活動時,才能將該參數設定為 true(即關閉伸縮群組的期望執行個體數功能),關閉伸縮群組的期望執行個體數功能時伸縮群組目前的 DesiredCapacity 屬性也會被清空,但伸縮群組中目前的執行個體數量不發生變化。 |
false |
| ScalingPolicy |
string |
否 |
指定伸縮群組的回收模式。取值範圍:
ScalingPolicy 指定伸縮群組的回收模式,但執行個體被移出伸縮群組時的具體動作,由 RemoveInstances 的 RemovePolicy 參數決定,更多資訊,請參見 RemoveInstances 。 |
recycle |
| HealthCheckTypes |
array |
否 |
伸縮群組的健康檢查方式。 說明
使用此參數可以設定多個值,開啟多個健康檢查選項。如果設定了 HealthCheckType 參數,則本參數將被忽略。 |
|
|
string |
否 |
伸縮群組的健康檢查方式清單。取值範圍:
預設值:ECS。 |
ECS |
|
| StopInstanceTimeout |
integer |
否 |
縮容流程中等待 ECS 執行個體停機成功的逾時時間,單位為秒。 取值範圍:30~240。 說明
|
60 |
| CapacityOptions |
object |
否 |
容量選項。 |
|
| OnDemandBaseCapacity |
integer |
否 |
已有伸縮群組內所需要的隨收隨付執行個體數的最小值,當伸縮群組內隨收隨付執行個體個數少於該值時,系統將優先建立隨收隨付執行個體。取值範圍:0~1000。 當 |
30 |
| OnDemandPercentageAboveBaseCapacity |
integer |
否 |
伸縮群組滿足最小隨收隨付執行個體數 當 |
20 |
| CompensateWithOnDemand |
boolean |
否 |
當
|
true |
| SpotAutoReplaceOnDemand |
boolean |
否 |
當開啟
預設值:false。 |
true |
| PriceComparisonMode |
string |
否 |
伸縮群組成本最佳化策略的比價模式。取值範圍:
預設值:PricePerUnit。 |
PricePerUnit |
| BalanceMode |
string |
否 |
可用區均衡模式,僅當開啟可用區均衡模式時生效。取值範圍:
預設值:BalancedBestEffort。 |
BalancedBestEffort |
| AutoRebalance |
boolean |
否 |
是否開啟伸縮群組自動均衡,僅當可用區均衡伸縮群組開啟了 BalancedOnly 才生效。取值範圍:
預設值: false。 |
false |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
樣本
正常返回樣本
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。