區別于ExecuteScalingRule接口,您無需提前創建伸縮規則,直接調用API ScaleWithAdjustment接口快速基于指定調整規則觸發彈性擴縮容。
接口說明
- 調用該接口前,請確保滿足以下條件:
- 伸縮組處于 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 | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ScalingGroupId | string | 是 | 伸縮組的 ID。 | asg-j6c1o397427hyjdc**** |
AdjustmentType | string | 是 | 伸縮活動調整方式,取值范圍:
| QuantityChangeInCapacity |
AdjustmentValue | integer | 是 | 伸縮活動調整值。任何情況下,單次調整的 ECS 實例臺數都不能超過 1000,否則會導致調整失敗。不同調整方式對應的取值范圍:
| 100 |
MinAdjustmentMagnitude | integer | 否 | 伸縮活動最小調整實例數,僅當 | 1 |
ClientToken | string | 否 | 用于保證請求的冪等性,防止重復提交請求。由客戶端生成該參數值,要保證在不同請求間唯一,最大值不超過 64 個 ASCII 字符,且該參數值中不能包含非 ASCII 字符。 | 123e4567-e89b-12d3-a456-42665544**** |
SyncActivity | boolean | 否 | 伸縮活動同步執行開關,僅對具有期望實例數配置項的伸縮組有效。取值范圍:
說明
關于期望實例數的更多信息,請參見期望實例數。
默認值:false。 | false |
Overrides | object | 否 | ECI 伸縮組擴容指定覆寫參數。 | |
Cpu | float | 否 | 實例級別 vCPU 大小。單位:核。 | 2 |
Memory | float | 否 | 實例級別內存大小。單位:GiB。 | 4 |
ContainerOverrides | array<object> | 否 | 覆寫容器列表參數。 | |
object | 否 | 覆寫容器列表參數。 | ||
Name | string | 否 | 容器名稱。當需要覆寫容器參數時,必須指定容器名稱,容器名稱與伸縮配置容器名稱相匹配時,方可覆寫容器參數。 | container-1 |
Args | array | 否 | 容器啟動命令對應的參數。最多 10 個。 | |
string | 否 | 容器啟動命令對應的參數。最多 10 個。 | arg | |
Commands | array | 否 | 容器啟動命令。最多 20 個。每個命令最多包含 256 個字符。 | |
string | 否 | 容器啟動命令。最多 20 個。每個命令最多包含 256 個字符。 | sleep | |
EnvironmentVars | array<object> | 否 | 環境變量的信息列表。 | |
object | 否 | 環境變量的信息列表。 | ||
Key | string | 否 | 環境變量名。長度為 1~128 個字符。格式要求: | PATH |
Value | string | 否 | 環境變量值。長度為 0~256 位。 | /usr/local/tomcat |
Cpu | float | 否 | 容器 vCPU 核數。單位:核。 | 2 |
Memory | float | 否 | 容器內存大小。單位:GiB。 | 4 |
LifecycleHookContext | object | 否 | 生命周期掛鉤上下文信息。 | |
DisableLifecycleHook | boolean | 否 | 伸縮活動禁用所有生命周期掛鉤。取值范圍:
| false |
IgnoredLifecycleHookIds | array | 否 | 伸縮活動禁用的生命周期掛鉤 ID 列表。 | |
string | 否 | 伸縮活動禁用的生命周期掛鉤 ID 列表。 | ash-bp14zolna43z266bq*** | |
ActivityMetadata | string | 否 | 伸縮活動的元數據。 | {"key":"value"} |
返回參數
示例
正常返回示例
JSON
格式
{
"ScalingActivityId": "asa-bp175o6f6ego3r2j****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"ActivityType": "CapacityChange"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-03-13 | OpenAPI 入參發生變更 | 查看變更詳情 |
2023-12-06 | OpenAPI 入參發生變更 | 查看變更詳情 |