調用API EnterStandby將伸縮組內的ECS執行個體或ECI執行個體設定為備用狀態,方便您自行管理ECS執行個體或ECI執行個體的生命週期。
介面說明
- 如果伸縮組關聯了Server Load Balancer執行個體,會把負載平衡中對應的執行個體權重設定為0。
- 當執行個體處於備用狀態時,如果您需要移出伸縮組並釋放執行個體,則可以正常手動將該執行個體移出伸縮組並釋放。
- 對於伸縮組數量變化或監控任務觸發的自動縮容的伸縮活動,不會移出處於備用狀態的執行個體。
- 當執行個體處於備用狀態時,執行個體如果處於非健康狀態(例如停止中、重啟中等),執行個體的健全狀態檢查狀態不會被更新,並且不會觸發移出不健康執行個體的伸縮活動,只有執行個體退出備用狀態後才會重新更新健全狀態檢查狀態。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
|
名稱 |
類型 |
是否必選 |
樣本值 |
描述 |
| Action | String | 是 | EnterStandby | 系統規定參數。取值:EnterStandby。 |
| ScalingGroupId | String | 是 | asg-bp1fo0dbtsbmqa9h**** | 伸縮組的ID。 |
| ClientToken | String | 否 | 123e4567-e89b-12d3-a456-42665544**** | 保證請求等冪性。從您的用戶端產生一個參數值,確保不同請求之間該參數值唯一。 只支援ASCII字元,且不能超過64個字元。更多資訊,請參見如何保證等冪性。 |
| InstanceId.N | String | 否 | i-28wt4**** | ECS執行個體或ECI執行個體的ID。 |
| Async | Boolean | 否 | false | 是否採用非同步任務方式執行。取值範圍:
預設值: false。 |
返回資料
名稱 |
類型 |
樣本值 |
描述 |
| RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** | 請求ID。 |
| ScalingActivityId | String | asa-2zeb04oym05qaceq**** | 調用伸縮活動ID。 |
樣本
請求樣本
http(s)://ess.aliyuncs.com/?Action=EnterStandby
&ScalingGroupId=asg-bp1fo0dbtsbmqa9h****
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&InstanceId=["i-28wt4****"]
&Async=false
&公用請求參數
正常返回樣本
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<EnterStandbyResponse>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
<ScalingActivityId>asa-2zeb04oym05qaceq****</ScalingActivityId>
</EnterStandbyResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"ScalingActivityId" : "asa-2zeb04oym05qaceq****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
HttpCode |
錯誤碼 |
錯誤資訊 |
描述 |
403 |
Forbidden.Unauthorized |
A required authorization for the specified action is not supplied. |
RAM使用者無許可權調用該介面,請聯絡主帳號授權後重試。 |
404 |
InvalidInstanceId.NotFound |
Instance "XXX" does not exist. |
指定的ECS執行個體或ECI執行個體不存在。 |
404 |
InvalidScalingGroupId.NotFound |
The specified scaling group does not exist. |
指定的伸縮組不存在。 |