在您需要將新的伸縮配置應用到伸縮組實例中時，或需要更新伸縮組中實例的鏡像時，您可以調用本接口完成伸縮組中實例的刷新。
接口說明
- 伸縮組同時刻只能有一個正在運行中的實例刷新任務。
- 目前該功能僅支持擴容策略為優先級策略的 ECS 伸縮組。使用 vCPU 個數計算伸縮組容量的伸縮組和實例回收模式為停機回收模式、強制停機回收模式的伸縮組不支持該功能。
- 實例刷新期間，可以進行正常擴縮容，但擴容時會以實例刷新的期望配置進行擴容。
- 伸縮組手動添加的實例、處于備用狀態、保護狀態的實例會被實例刷新任務忽略，不參與實例刷新。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ess:StartInstanceRefresh | update | *ScalingGroup acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ScalingGroupId | string | 是 | 伸縮組 ID。 | asg-bp18p2yfxow2dloq**** |
| ClientToken | string | 否 | 保證請求冪等性。從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。只支持 ASCII 字符，且不能超過 64 個字符。更多信息，請參見如何保證冪等性。 | 123e4567-e89b-12d3-a456-42665544**** |
| RegionId | string | 是 | 伸縮組所屬的地域 ID。 | cn-hangzhou |
| MinHealthyPercentage | integer | 否 | 實例刷新期間，保持伸縮組中正常提供服務占伸縮組容量的比例。取值范圍 0～100。 默認值：80。 | 80 |
| MaxHealthyPercentage | integer | 否 | 實例刷新期間，伸縮組中實例可以超出伸縮組容量的比例。取值范圍 100～200。 默認值：120。 說明
當 MinHealthyPercentage = MaxHealthyPercentage = 100 時，每次會刷新 1 個實例。
| 100 |
| DesiredConfiguration | object | 否 | 實例刷新的期望配置。 說明
| |
| ImageId | string | 否 | 鏡像 ID。 說明
| m-2ze8cqacj7opnf*** |
| ScalingConfigurationId | string | 否 | 伸縮配置的 ID。 說明
-實例刷新任務執行成功后，伸縮組生效的伸縮配置會更新為該配置。
| asc-2zed7lqn4ts4**** |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"InstanceRefreshTaskId": "ir-a12ds234fasd*****"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-12-10 | OpenAPI 入參發生變更 | 查看變更詳情 |