ScaleWithAdjustment - Auto Scaling

基於指定調整規則觸發彈性擴縮容。

介面說明

呼叫該介面前，請確保滿足以下條件：
- 伸縮組處於 Active 狀態。
- 伸縮組內沒有執行中的伸縮活動。
當伸縮組沒有執行中的伸縮活動時，該介面可以繞過冷卻時間（Cooldown）直接執行伸縮活動。
如果伸縮規則需要增加的 ECS 執行個體數加上當前伸縮組的執行個體數（Total Capacity）大於最大執行個體數（MaxSize），則按 Total Capacity=MaxSize 執行伸縮活動。
如果當前伸縮組的執行個體數（Total Capacity）減去伸縮規則需要減少的 ECS 執行個體數小於最小執行個體數（MinSize），則按 Total Capacity=MinSize 執行伸縮活動。

呼叫該介面返回成功，只是表示彈性伸縮服務接受了該介面的呼叫請求，可以執行伸縮活動，但不代表伸縮活動能夠執行成功。您需要透過返回的ScalingActivityId查看該伸縮活動的執行狀態。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ess:ScaleWithAdjustment

update

*ScalingGroup

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

無

請求參數

名稱	類型	必填	描述	樣本值
ScalingGroupId	string	是	伸縮組的 ID。	asg-j6c1o397427hyjdc****
AdjustmentType	string	是	伸縮活動調整方式，取值範圍： QuantityChangeInCapacity：增加或減少指定數量的 ECS 執行個體。 PercentChangeInCapacity：增加或減少指定比例的 ECS 執行個體。 TotalCapacity：將當前伸縮組的 ECS 執行個體數量調整到指定數量。	QuantityChangeInCapacity
AdjustmentValue	integer	是	伸縮活動調整值。任何情況下，單次調整的 ECS 執行個體台數都不能超過 1000，否則會導致調整失敗。不同調整方式對應的取值範圍： QuantityChangeInCapacity：-1000~1000。 PercentChangeInCapacity：-100~10000。 TotalCapacity：0~2000。	100
MinAdjustmentMagnitude	integer	否	伸縮活動最小調整執行個體數，僅當`AdjustmentType`為`PercentChangeInCapacity`時生效。	1
ClientToken	string	否	用於保證請求的冪等性，防止重複提交請求。由用戶端產生該參數值，要保證在不同請求之間唯一，最大值不超過 64 個 ASCII 字元，且該參數值中不能包含非 ASCII 字元。	123e4567-e89b-12d3-a456-42665544****
SyncActivity	boolean	否	伸縮活動同步執行開關，僅對具有期望執行個體數配置項的伸縮組有效。取值範圍： true：同步流程，即執行伸縮規則時會直接觸發伸縮組的擴縮容活動。 false：非同步流程，即修改伸縮組內的期望執行個體數時，不會立刻觸發伸縮組的實際擴縮容活動，需等待期望執行個體數變化後，系統自動檢測期望執行個體數與伸縮組內當前執行個體數不一致，才會觸發擴縮容活動。說明關於期望執行個體數的更多資訊，請參見期望執行個體數。預設值：false。	false
Overrides	object	否	ECI 類型的伸縮組擴容指定覆寫參數。
Cpu	number	否	執行個體級別 vCPU 大小。單位：核。	2
Memory	number	否	執行個體級別記憶體大小。單位：GiB。	4
UserData	string	否
ContainerOverride	array<object>	否	覆寫容器列表參數。
	array<object>	否	覆寫容器列表參數。
Command	array	否	容器啟動命令。最多 20 個。每個命令最多包含 256 個字元。
	string	否	容器啟動命令。最多 20 個。每個命令最多包含 256 個字元。	sleep
Memory	number	否	容器的記憶體大小。單位：GiB。	4
Arg	array	否	容器啟動命令對應的參數。最多 10 個。
	string	否	容器啟動命令對應的參數。最多 10 個。	arg
Cpu	number	否	容器的 vCPU 大小。單位：核。	2
EnvironmentVar	array<object>	否	環境變數的資訊列表。
	object	否	環境變數的資訊列表。
Value	string	否	Environment variable value. Length: 0 to 256 characters.	/usr/local/tomcat
Key	string	否	Environment variable name. Length: 1 to 128 characters. Format requirements: `[0-9a-zA-Z]` and underscores (_); must not start with a digit.	PATH
Name	string	否	容器名稱。當需要覆寫容器參數時，必須指定容器名稱，容器名稱與伸縮配置中的容器名稱相匹配時，方可覆寫容器參數。	container-1
LifecycleHookContext	object	否	生命週期掛鉤的上下文資訊。
DisableLifecycleHook	boolean	否	伸縮活動是否禁用所有生命週期掛鉤功能。取值範圍： true：禁用。 false：不禁用。	false
IgnoredLifecycleHookIds	array	否	伸縮活動禁用的生命週期掛鉤 ID 列表。
	string	否	伸縮活動禁用的生命週期掛鉤 ID 列表。	ash-bp14zolna43z266bq***
LifecycleHookResult	string	否
ActivityMetadata	string	否	伸縮活動的中繼資料。	{"key":"value"}
ExecutionMode	string	否	執行模式。取值範圍： None：未指定，正常擴縮容。 PlanOnly：不觸發擴縮容，僅執行彈性規劃，在 PlanResult 中返回規劃的結果，包括執行個體規格、可用區 ID、付費類型和建立的執行個體數量等資訊。預設為 None。	PlanOnly

返回參數

名稱	類型	描述	樣本值
	object	基於指定調整規則觸發彈性擴縮容返回參數。
ScalingActivityId	string	伸縮活動的 ID。	asa-bp175o6f6ego3r2j****
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
ActivityType	string	伸縮活動的類型。當`ActivityType`為`CapacityChange`時，表示返回值`ScalingActivityId`對應伸縮活動僅修改伸縮組期望執行個體數，沒有立刻執行擴縮。適用範圍：期望執行個體數類型的伸縮組。	CapacityChange
PlanResult	object	當 ExecutionMode 為 PlanOnly 時，返回的彈性規劃的結果。
ResourceAllocations	array<object>	彈性規劃結果中的資源分配資訊。
	object
ZoneId	string	Zone ID.	cn-beijing-g
InstanceType	string	Instance type.	ecs.u1-c1m8.large
SpotStrategy	string	The spot strategy of the instance. Valid values: NoSpot: A normal pay-as-you-go instance. SpotWithPriceLimit: A spot instance with a specified maximum price. SpotAsPriceGo: A spot instance for which the system automatically bids based on the current marketplace price.	NoSpot
Amount	integer	Number of instances.	1
InstanceChargeType	string	Billing method. Valid return values are as follows: Prepaid: subscription. Postpaid: pay-as-you-go.	Postpaid

樣本

正常返回樣本

JSON格式

{
  "ScalingActivityId": "asa-bp175o6f6ego3r2j****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "ActivityType": "CapacityChange",
  "PlanResult": {
    "ResourceAllocations": [
      {
        "ZoneId": "cn-beijing-g",
        "InstanceType": "ecs.u1-c1m8.large",
        "SpotStrategy": "NoSpot",
        "Amount": 1,
        "InstanceChargeType": "Postpaid"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
403	Forbidden.Forbidden	Operation Forbidden

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

變更歷史

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