DetachInstances - 從一個伸縮組移出一台或多台執行個體 - Auto Scaling

介面說明

調用該介面前，請確保滿足以下條件：
- 目標伸縮組必須處於啟用（Enable）狀態。
- 目標伸縮組沒有進行中的伸縮活動。
說明
目標伸縮組沒有進行中的伸縮活動時，該介面可以繞過冷卻時間直接觸發伸縮活動。
使用該介面，您需要注意以下事項：
- 移出 ECS 執行個體、ECI 執行個體或受管理的執行個體之後，該執行個體可以獨立於伸縮組而單獨存在，您可以調用 AttachInstances 介面將 ECS 執行個體、ECI 執行個體或受管理的執行個體再次添加到其他伸縮組。
- 調用該介面移出一台 ECS 執行個體、ECI 執行個體或受管理的執行個體並不會停止或釋放該執行個體。
- 介面成功調用後，僅表示Auto Scaling服務接受了該介面調用的請求。可以正常觸發伸縮活動，但不能保證伸縮活動執行成功，您需要通過返回的 ScalingActivityId 查看伸縮活動的狀態。
- 目標伸縮組的 ECS 執行個體、ECI 執行個體或受管理的執行個體數量減去當前移出的 ECS 執行個體、ECI 執行個體或受管理的執行個體數量不能小於伸縮組最小執行個體數（MinSize），否則會報錯。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ess:DetachInstances

update

*ScalingGroup

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

無

請求參數

名稱	類型	必填	描述	樣本值
ScalingGroupId	string	是	伸縮組的 ID。	asg-bp1igpak5ft1flyp****
DecreaseDesiredCapacity	boolean	否	是否修改期望執行個體數。取值範圍： true：ECS 執行個體、ECI 執行個體或受管理的執行個體移出伸縮組後，期望執行個體數也減少相應數量。 false：ECS 執行個體、ECI 執行個體或受管理的執行個體移出伸縮組後，期望執行個體數不會變化。預設值：true。	true
DetachOption	string	否	指定是否停止使用 ECS 執行個體或 ECI 執行個體作為Server Load Balancer執行個體的後端伺服器（即將 ECS 執行個體或 ECI 執行個體移出Server Load Balancer執行個體的預設伺服器組和虛擬伺服器組），以及是否將 ECS 執行個體或 ECI 執行個體移出 RDS 執行個體的訪問白名單。 both：將 ECS 執行個體或 ECI 執行個體移出Server Load Balancer執行個體的預設伺服器組和虛擬伺服器組，並將 ECS 執行個體或 ECI 執行個體移出 RDS 執行個體的訪問白名單。說明伸縮組移出受管理的執行個體時不支援設定該參數項。	both
InstanceIds	array	是	待移出 ECS 執行個體、ECI 執行個體或受管理的執行個體的 ID。
	string	否	待移出 ECS 執行個體、ECI 執行個體或受管理的執行個體的 ID。舉例如下所示：待移出的 ECS 執行個體 ID 為`i-bp109k5j3dum1ce6**`。待移出的 ECI 執行個體 ID 為`eci-bp17gw49eu09yiwm`。待移出的受管理的執行個體 ID 為 `mi-d23fsd****`。說明一次調用請求只支援移出一種類型的執行個體。	i-bp109k5j3dum1ce6****
LifecycleHook	boolean	否	伸縮組移出 ECS 執行個體或 ECI 執行個體時，是否觸發縮容生命週期掛鈎。取值範圍： true：觸發。 false：不觸發。說明伸縮組移出受管理的執行個體時不支援設定該參數項。預設值：false。	false
IgnoreInvalidInstance	boolean	否	從伸縮組移出一批執行個體時，是否忽略其中無效的執行個體。取值範圍： true：從伸縮組中移出一批執行個體時，會忽略其中無效的執行個體。如果存在無效的執行個體，並且有效執行個體被成功移除時，伸縮活動執行狀態也會顯示為警告狀態，可以從伸縮活動詳情查看無效的執行個體。 false：從伸縮組中移出一批執行個體時，不會忽略無效的執行個體。如果一批執行個體中存在無效的執行個體，請求會報錯。預設值：false。	false
ClientToken	string	否	保證請求等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。只支援 ASCII 字元，且不能超過 64 個字元。更多資訊，請參見如何保證等冪性。	123e4567-e89b-12d3-a456-42665544****

返回參數

名稱	類型	描述	樣本值
	object
ScalingActivityId	string	伸縮活動的 ID。	asa-bp1gbswjhjrw8tko****
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

樣本

正常返回樣本

JSON格式

{
  "ScalingActivityId": "asa-bp1gbswjhjrw8tko****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
500	InternalError	The request processing has failed due to some unknown error, exception or failure.

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

變更歷史

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