API 概覽 - Auto Scaling

API標準及多語言預置SDK

本產品（Ess/2014-08-28）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。

在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。

自訂簽名情境

若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。

帳號與安全準備

阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。

伸縮群組

API	標題	API概述
CreateScalingGroup	建立一個伸縮群組。	如果您需要根據業務變動需求與策略自動增加或減少指定類型的執行個體數量，則可以透過呼叫 API CreateScalingGroup 建立伸縮群組來自動調整您的業務運算能力（即執行個體數量）。
DeleteScalingGroup	刪除一個伸縮組	刪除一個伸縮組。
ModifyScalingGroup	修改一個伸縮群組。	如果您需要根據業務變動需求與策略自動增加或減少指定類型的執行個體數量，則可以透過設定伸縮群組來自動調整您的業務運算能力（即執行個體數量）。如果目前伸縮群組屬性不再滿足業務需求，則您可以呼叫 API ModifyScalingGroup 修改伸縮群組屬性（例如最大執行個體數、最小執行個體數或期望執行個體數等屬性），避免重新建立伸縮群組並重新設定相關屬性，節省了時間和資源成本。
EnableScalingGroup	啟用一個伸縮組	啟用一個伸縮組。
DisableScalingGroup	停用一個伸縮組	停用一個伸縮組。
SetGroupDeletionProtection	為伸縮組開啟或關閉刪除保護	為伸縮組開啟或關閉刪除保護。
AttachLoadBalancers	新增一個或多個負載平衡執行個體	新增一個或多個負載平衡執行個體。
DetachLoadBalancers	移除一個或多個負載平衡執行個體	移除一個或多個負載平衡執行個體。
DetachDBInstances	移除一個或多個 RDS 執行個體	移除一個或多個 RDS 執行個體。
AttachDBInstances	新增一個或多個RDS執行個體	新增一個或多個RDS執行個體。
AttachVServerGroups	新增負載平衡執行個體下虛擬伺服器群組。	新增負載平衡執行個體下的一個或多個虛擬伺服器群組。
DetachVServerGroups	移除一個或多個虛擬伺服器群組。	移除一個或多個虛擬伺服器群組。
DescribeScalingGroups	查詢伸縮群組列表	如果您需要查看伸縮群組的基本資訊、伸縮群組內執行個體、伸縮配置等資訊，您可以呼叫API DescribeScalingGroups查詢該伸縮群組。
DescribeScalingInstances	查詢伸縮群組內ECS執行個體清單。	呼叫DescribeScalingInstances，透過伸縮群組ID查詢該伸縮群組內的ECS執行個體清單及執行個體資訊，包括目前伸縮群組中，執行狀態的搶占式執行個體總數、ECS執行個體總數、ECS執行個體的預熱狀態、生命週期狀態等。同時也支援指定執行個體健康狀態、生命週期狀態、建立方式等篩選符合要求的ECS執行個體。
DescribeScalingActivities	查詢伸縮活動。	透過 API DescribeScalingActivities 查看伸縮活動的詳情，了解透過定時任務、警示任務或手動執行伸縮規則等方式觸發伸縮活動的結果。例如，您可以在伸縮活動詳情頁查看到伸縮活動的狀態、活動起因、變化後總執行個體數等資訊。
DescribeScalingActivityDetail	查詢一個伸縮活動的詳細資訊	查詢一個伸縮活動的詳細資訊。
DescribeLimitation	查詢資源配額限制	查詢資源配額限制。
DescribeElasticStrength	查詢伸縮組的彈性強度	伸縮組配置的有效性很大程度決定了擴容過程的成功率。彈性伸縮透過彈性強度描述伸縮配置的有效性，讓配置的優良程度量化，幫助使用者針對性地最佳化伸縮配置。
VerifyAuthentication	檢測是否已授權彈性伸縮操作ECS資源	檢測是否已授權彈性伸縮操作ECS資源。
SuspendProcesses	暫停伸縮組中的指定流程	暫停伸縮組中的指定流程。
ResumeProcesses	恢復伸縮組中被暫停的流程	恢復伸縮組中被暫停的流程。
VerifyUser	驗證是否已開通彈性伸縮服務。	透過呼叫 API VerifyUser 驗證是否已開通彈性伸縮服務。

伸縮設定

API	標題	API概述
CreateScalingConfiguration	建立一個伸縮配置。	透過呼叫CreateScalingConfiguration介面，並指定伸縮群組ID、執行個體規格、執行個體映像等資訊，為伸縮群組建立一個ECS類型的伸縮配置。
DeleteScalingConfiguration	刪除一個伸縮配置	刪除一個伸縮配置。
ModifyScalingConfiguration	修改一個 ECS 類型伸縮配置。	如果目前的伸縮配置不滿足業務需求，您可以透過呼叫 API ModifyScalingConfiguration 修改 ECS 類型的伸縮配置（即待擴容的 ECS 執行個體範本）。
DescribeScalingConfigurations	查詢ECS類型伸縮配置資訊。	呼叫API DescribeScalingConfigurations查詢ECS類型伸縮配置的資訊，包括執行個體規格、映像等資訊，方便您提前了解彈性擴張時使用的ECS執行個體範本詳情。
DeactivateScalingConfiguration	使指定伸縮配置進入失效狀態	使指定伸縮配置進入失效狀態。

伸縮規則

API	標題	API概述
CreateScalingRule	建立一條伸縮規則。	建立一條伸縮規則。
DeleteScalingRule	刪除一條伸縮規則	刪除一條伸縮規則。
ModifyScalingRule	ModifyScalingRule	建立伸縮規則後，如果目前伸縮規則不再滿足需求，您可以呼叫 API ModifyScalingRule 修改一項或多項伸縮規則屬性，無需重新建立新的伸縮規則，避免不必要的重複操作，節約時間和資源成本。
DescribeScalingRules	查詢伸縮規則	查詢伸縮組下的伸縮規則，並列出伸縮規則的資訊。

觸發任務

API	標題	API概述
AttachInstances	為伸縮群組手動新增ECS執行個體	為伸縮群組手動新增ECS執行個體。
DetachInstances	從一個伸縮組移出一台或多台ECS執行個體	從一個伸縮組移出一台或多台ECS執行個體。
ExecuteScalingRule	執行一條伸縮規則	執行一條伸縮規則。
RemoveInstances	RemoveInstances	如果目前伸縮群組狀態為啟用狀態，且伸縮群組內不存在執行中的伸縮活動，您可以呼叫 API RemoveInstances 從一個伸縮群組刪除一台或多台不再需要的執行個體。

定時任務

API	標題	API概述
CreateScheduledTask	建立一個排程任務	建立一個排程任務。
DeleteScheduledTask	刪除一個排程任務	刪除一個排程任務。
ModifyScheduledTask	修改一個排程任務的資訊	修改一個排程任務的資訊。
DescribeScheduledTasks	DescribeScheduledTasks	定時任務是一種預設任務，可以在指定時間執行指定的伸縮規則，實現運算資源的自動擴縮容。定時任務建立完成後，您可以呼叫 API DescribeScheduledTasks 查詢定時任務的詳細資訊，例如，定時任務的觸發時間點、定時任務總數、執行定時任務的伸縮群組的 ID 等。

生命週期掛鉤

API	標題	API概述
CreateLifecycleHook	為伸縮群組建立一個或多個生命週期掛鉤	為伸縮群組建立一個或多個生命週期掛鉤。
DeleteLifecycleHook	刪除一個生命週期掛鉤	刪除一個生命週期掛鉤。
ModifyLifecycleHook	修改一個生命週期掛鉤的資訊	修改一個生命週期掛鉤的資訊。
DescribeLifecycleActions	查詢 Lifecycle Token	根據伸縮活動ID和狀態查詢 Lifecycle Token。
DescribeLifecycleHooks	查詢生命週期掛鉤詳情	呼叫DescribeLifecycleHooks透過指定生命週期掛鉤ID或伸縮群組ID來查詢生命週期掛鉤的資訊，包括等待狀態結束後的下一步動作、生命週期掛鉤對應的伸縮活動類型、通知物件識別碼、掛起等待時間等。
RecordLifecycleActionHeartbeat	延長生命週期掛鉤觸發後被暫停等待時間	延長一個生命週期掛鉤觸發後被暫停的 ECS 執行個體的等待時間。
CompleteLifecycleAction	提前結束伸縮活動的等待狀態	提前結束伸縮活動的等待狀態。

事件通知

API	標題	API概述
CreateNotificationConfiguration	CreateNotificationConfiguration	事件通知支援在發生指定類型的事件後，自動發送訊息到雲端監控、MNS主題和MNS佇列，可以幫助您即時掌握伸縮群組的動態，進一步實現自動化管理。如果目前事件通知的類型不再滿足業務需求，您可以呼叫API ModifyNotificationConfiguration修改彈性伸縮事件及資源變化通知，您無需重新建立新的事件通知，但不支援修改事件通知的通知方式。
DeleteNotificationConfiguration	刪除一條彈性伸縮事件及資源變化通知	刪除一條彈性伸縮事件及資源變化通知。
ModifyNotificationConfiguration	修改一條彈性伸縮事件及資源變化通知	修改一條彈性伸縮事件及資源變化通知。
DescribeNotificationConfigurations	DescribeNotificationConfigurations	呼叫 API DescribeNotificationConfiguration，透過伸縮群組 ID 查詢該伸縮群組的彈性伸縮事件及資源變化通知，包括事件通知類型和通知方式等。
DescribeNotificationTypes	查詢彈性伸縮事件及資源變化通知的類型	查詢彈性伸縮事件及資源變化通知的類型。

執行個體

API	標題	API概述
SetInstancesProtection	開始或停止保護伸縮群組內ECS執行個體	開始保護或者停止保護伸縮群組內的一台或者多台ECS執行個體。
SetInstanceHealth	設定伸縮組內 ECS 執行個體的健康狀態	設定伸縮組內 ECS 執行個體的健康狀態。
EnterStandby	將伸縮組內的ECS執行個體設定為備用狀態	將伸縮組內的ECS執行個體設定為備用狀態。
ExitStandby	使備用狀態執行個體進入執行狀態	使伸縮群組內處於備用狀態的 ECS 執行個體進入執行狀態。
RebalanceInstances	重新平衡ECS執行個體分布	重新平衡多可用區伸縮群組內ECS執行個體的分布。

地域

API	標題	API概述
DescribeRegions	查詢可以使用彈性伸縮服務的地域	查詢可以使用彈性伸縮服務的地域。

API	標題	API概述
ListTagResources	查詢彈性伸縮資源已經綁定的標籤清單。	查詢一個或多個彈性伸縮資源已經綁定的標籤清單。
ListTagKeys	查詢彈性伸縮資源標籤鍵的列表	查詢彈性伸縮資源標籤鍵的列表。
ListTagValues	查詢彈性伸縮資源標籤鍵對應的標籤值	查詢彈性伸縮資源標籤鍵對應的標籤值。
TagResources	為資源清單建立並綁定標籤。	為指定的彈性伸縮資源清單統一建立並綁定標籤。
UntagResources	為指定的彈性伸縮資源列表統一解除綁定標籤	解除綁定後，如果該標籤沒有綁定其他任何資源，會被自動刪除。

警報

API	標題	API概述
CreateAlarm	建立一個報警任務	建立一個報警任務。
DeleteAlarm	刪除一個警報任務	刪除一個警報任務。
DisableAlarm	停用一個警報任務	停用一個警報任務。
EnableAlarm	啟用一個警示任務	啟用一個警示任務。
ModifyAlarm	修改警報任務。	修改一個警報任務。
DescribeAlarms	查詢報警任務的資訊	查詢報警任務的資訊。

其他

API	標題	API概述
AttachAlbServerGroups	新增一或多個 ALB 伺服器群組	向伸縮群組新增一或多個 ALB 伺服器群組。
CreateEciScalingConfiguration	建立一個伸縮配置	建立一個ECI類型的伸縮配置。
DeleteEciScalingConfiguration	刪除一個伸縮配置	刪除一個 ECI 類型的伸縮配置。
DescribeEciScalingConfigurations	DescribeEciScalingConfigurations	呼叫DescribeEciScalingConfigurations介面，並可以指定伸縮群組的ID、伸縮配置的ID或名稱等參數查詢ECI類型的伸縮配置資訊，例如執行個體的搶佔策略、容器群組的執行個體規格、容器映像的拉取策略、ECI執行個體作為後端伺服器時的權重等。
DetachAlbServerGroups	移出一個或多個 ALB 伺服器組	從伸縮組移出一個或多個 ALB 伺服器組。
ModifyEciScalingConfiguration	修改一個伸縮配置	呼叫 ModifyScalingConfiguration 修改一個 ECI 類型的伸縮配置。
ScaleWithAdjustment	基於指定調整規則觸發彈性擴縮容	基於指定調整規則觸發彈性擴縮容。
ChangeResourceGroup	更改伸縮群組所屬的資源群組	將一個伸縮群組作為資源加入一個資源群組。
AttachServerGroups	添加一個或多個負載平衡伺服器群組	從伸縮群組新增一個或多個負載平衡伺服器群組，支援的伺服器群組類型包括：應用型負載平衡ALB (Application Load Balancer)、網路型負載平衡NLB (Network Load Balancer)。
DetachServerGroups	DetachServerGroups	對於需要動態調整執行個體數量來應對業務變化負載以及確保應用程式的高可用性場景，呼叫 API DetachServerGroups 從伸縮群組移除一個或多個負載平衡伺服器群組，支援的伺服器群組類型包括應用型負載平衡 ALB、網路型負載平衡 NLB 和閘道型負載平衡 GWLB，可以實現對負載平衡策略的動態調整，並幫助提高系統的高可用性。
ModifyInstanceAttribute	ModifyInstanceAttribute	呼叫ModifyInstanceAttribute，並指定伸縮群組內執行個體的ID、伸縮群組的ID、伸縮群組所屬的地域ID等參數，修改伸縮群組中一台ECS執行個體的部分資訊，目前僅支援修改手動新增至伸縮群組中執行個體的生命週期託管屬性。
DescribePatternTypes	根據執行個體屬性查詢執行個體規格。	使用指定執行個體屬性方式配置伸縮配置時，呼叫 API DescribePatternTypes 介面根據指定執行個體的 vCPU 核心數、記憶體大小、規格族級別以及可接受的最高價格等屬性，篩選出符合要求的執行個體規格。
ApplyScalingGroup	基於設定檔管理伸縮群組。	如果您需要透過設定檔方式快速建立和管理ECI類型的伸縮群組，則可以透過呼叫API ApplyScalingGroup來實現該功能。
ModifyAlertConfiguration	設定伸縮群組中需要發送訊息通知的伸縮活動狀態。	伸縮活動在執行成功、失敗或者被拒絕時，彈性伸縮支援透過簡訊、電子郵件方式發送訊息通知，您需要在接收到訊息後自行處理相關事件。您可以呼叫 API ModifyAlertConfiguration 設定伸縮群組中需要發送簡訊、電子郵件通知的伸縮活動狀態，方便您及時了解某個伸縮活動的變化，快速回應提高擴縮容效率。
DescribeAlertConfiguration	查詢伸縮群組中需要發送訊息的伸縮活動狀態。	伸縮活動在執行成功、失敗或者被拒絕時，彈性伸縮支援透過簡訊、郵件方式發送訊息通知，您需要在接收到訊息後自行處理相關事件。您可以呼叫 API DescribeAlertConfiguration 查詢伸縮群組中的發送簡訊、郵件通知的伸縮活動狀態，方便您及時了解某個伸縮活動的變化，快速回應提高擴縮容效率。
SuspendInstanceRefresh	暫停執行個體重新整理任務。	執行個體重新整理任務執行期間，如果您覺得設定存在問題，但不確定是否需要回滾，您可以呼叫此API暫停執行個體重新整理任務，在此期間，您可以檢查設定是否正確。
ResumeInstanceRefresh	恢復暫停中的執行個體刷新任務。	恢復一個處於暫停狀態的執行個體刷新任務。
CancelInstanceRefresh	取消執行個體刷新任務。	取消執行個體刷新任務，會保留已經完成替換和擴容的新執行個體。
DescribeInstanceRefreshes	查詢執行個體重新整理任務清單。	如果您需要查看執行個體重新整理任務的基本資訊、執行個體重新整理任務的進度等資訊，您可以呼叫DescribeInstanceRefreshes查詢該伸縮群組的執行個體重新整理任務。
RollbackInstanceRefresh	回滾執行個體刷新任務。	在執行個體刷新任務執行過程中，如果發現期望設定不符合需求，您可以呼叫此API來回滾執行個體刷新任務。在回滾時，系統將使用伸縮群組目前生效的設定來建立新的執行個體，以替換那些基於期望設定建立的執行個體。
StartInstanceRefresh	啟動執行個體刷新任務。	當您需要將新的伸縮配置應用到伸縮群組執行個體中時，或需要更新伸縮群組中執行個體的映像時，您可以呼叫本介面完成伸縮群組中執行個體的刷新。