在您需要將新的伸縮配置應用到伸縮組實例中時,或需要更新伸縮組中實例的鏡像時,您可以調用本接口完成伸縮組中實例的刷新。
接口說明
- 伸縮組同時刻只能有一個正在運行中的實例刷新任務。
- 目前該功能僅支持擴容策略為優先級策略的ECS伸縮組。使用vCPU個數計算伸縮組容量的伸縮組和實例回收模式為停機回收模式、強制停機回收模式的伸縮組不支持該功能。
- 實例刷新期間,可以進行正常擴縮容,但擴容時會以實例刷新的期望配置進行擴容。
- 伸縮組手動添加的實例、處于備用狀態、保護狀態的實例會被實例刷新任務忽略,不參與實例刷新。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | StartInstanceRefresh | 系統規定參數。取值:StartInstanceRefresh。 |
RegionId | String | 是 | cn-hangzhou | 伸縮組所屬的地域ID。 |
ClientToken | String | 否 | 123e4567-e89b-12d3-a456-42665544**** | 保證請求冪等性。從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。只支持ASCII字符,且不能超過64個字符。更多信息,請參見如何保證冪等性。 |
ScalingGroupId | String | 是 | asg-bp18p2yfxow2dloq**** | 伸縮組ID。 |
MinHealthyPercentage | Integer | 否 | 80 | 實例刷新期間,保持伸縮組中正常提供服務占伸縮組容量的比例。取值范圍 0~100。 默認值:80。 |
MaxHealthyPercentage | Integer | 否 | 100 | 實例刷新期間,伸縮組中實例可以超出伸縮組容量的比例。取值范圍 100~200。 默認值:120。 說明 當MinHealthyPercentage = MaxHealthyPercentage = 100時,每次會刷新1個實例。 |
DesiredConfiguration.ImageId | String | 否 | m-2ze8cqacj7opnf*** | 鏡像ID。 說明
|
DesiredConfiguration.ScalingConfigurationId | String | 否 | asc-2zed7lqn4ts4**** | 伸縮配置的ID。 說明 實例刷新任務執行成功后,伸縮組生效的伸縮配置會更新為該配置。 |
返回數據
名稱 |
類型 |
示例值 |
描述 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** | 請求ID。 |
InstanceRefreshTaskId | String | ir-a12ds234fasd***** | 實例刷新任務ID。 |
示例
請求示例
http(s)://ess.aliyuncs.com/?Action=StartInstanceRefresh
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&ScalingGroupId=asg-bp18p2yfxow2dloq****
&MinHealthyPercentage=80
&MaxHealthyPercentage=100
&DesiredConfiguration={"ImageId":"m-2ze8cqacj7opnf***","ScalingConfigurationId":"asc-2zed7lqn4ts4****"}
&公共請求參數
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<StartInstanceRefreshResponse>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
<InstanceRefreshTaskId>ir-a12ds234fasd*****</InstanceRefreshTaskId>
</StartInstanceRefreshResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"InstanceRefreshTaskId" : "ir-a12ds234fasd*****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
文檔內容是否對您有幫助?