調用API EnterStandby將伸縮組內的ECS實例或ECI實例設置為備用狀態,方便您自行管理ECS實例或ECI實例的生命周期。
接口說明
- 如果伸縮組關聯了負載均衡實例,會把負載均衡中對應的實例權重設置為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. |
指定的伸縮組不存在。 |
文檔內容是否對您有幫助?