StartInstanceRefresh

當您需要將新的伸縮配置應用到伸縮組執行個體中時，或需要更新伸縮組中執行個體的映像時，您可以呼叫本介面完成伸縮組中執行個體的重新整理。

介面說明

伸縮組同時刻只能有一個正在運行中的執行個體重新整理任務。
目前該功能僅支援擴容策略為優先級策略的 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	否	執行個體重新整理的期望配置。說明 ScalingConfigurationId 、ImageId、LaunchTemplateId、Containers 不可以同時設定。當該參數為空時，以伸縮組當前生效的配置進行重新整理。執行個體重新整理任務執行成功後，伸縮組生效的伸縮配置會更新為該配置。
ImageId	string	否	映像 ID。說明執行個體重新整理任務執行成功後，伸縮組當前生效的配置資訊中的映像配置會更新為該映像。伸縮組當前生效的配置資訊來源是啟動範本時不支援設定該參數。	m-2ze8cqacj7opnf***
ScalingConfigurationId	string	否	伸縮配置的 ID。	asc-2zed7lqn4ts4****
LaunchTemplateId	string	否	執行個體啟動範本的 ID，用於指定伸縮組從執行個體啟動範本獲取啟動配置資訊。	lt-2ze2qli30u***
LaunchTemplateVersion	string	否	執行個體啟動範本的版本。取值範圍：固定的範本版本號。 Default：始終使用範本預設版本。 Latest：始終使用範本最新版本。說明版本設定為 Default、Latest 時，執行個體重新整理任務不支援回滾。	8
LaunchTemplateOverrides	array<object>	否	擴展啟動範本的執行個體規格資訊。
	object	否	擴展啟動範本的執行個體規格資訊。
InstanceType	string	否	本參數用於指定執行個體規格，會覆蓋啟動範本中的執行個體規格。說明僅當 LaunchTemplateId 參數指定了啟動範本時，本參數生效。	ecs.c5.2xlarge
Containers	array<object>	否	執行個體包含的容器列表。說明該參數僅支援 ECI 類型伸縮組。只會重新整理當前伸縮配置容器列表中和`Container.Name`相同的容器配置。
	array<object>	否	執行個體包含的容器列表。
Name	string	否	自訂的容器名稱。	nginx
Image	string	否	容器映像。	registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest
Commands	array	否	容器啟動命令。最多 20 個。每個命令最多包含 256 個字元。
	string	否	容器啟動命令。最多 20 個。每個命令最多包含 256 個字元。	sleep
Args	array	否	容器啟動命令對應的參數。最多 10 個。
	string	否	容器啟動命令對應的參數。最多 10 個。	100
EnvironmentVars	array<object>	否	環境變數的資訊。
	object	否	環境變數的資訊。
Key	string	否	環境變數名。長度為 1~128 位。格式要求：[0-9a-zA-Z]，以及底線，不能以數字開頭。	PATH
Value	string	否	環境變數值。長度為 0~256 位。	/usr/local/bin
FieldRefFieldPath	string	否	說明該參數未開放使用。	fieldPath
SkipMatching	boolean	否	是否跳過和期望配置匹配的執行個體。說明系統會根據期望伸縮配置的 ID 界定是否匹配，不會對比具體的配置項。取值範圍： true：跳過。當啟動執行個體重新整理任務時，系統會檢查每個執行個體的配置。對於已經使用期望配置建立的執行個體，不執行重新整理操作。 false：不跳過。在啟動執行個體重新整理任務後，重新整理任務啟動時所有伸縮組中的執行個體。預設值：true。	true
Checkpoints	array<object>	否	重新整理任務檢查點：指定在執行個體重新整理過程中，當新執行個體佔比達到設定值時自動暫停任務 CheckpointPauseTime 分鐘。
	object	否	重新整理任務檢查點：指定在執行個體重新整理過程中，當新執行個體佔比達到設定值時自動暫停任務`CheckpointPauseTime`分鐘。
Percentage	integer	否	伸縮組中新執行個體佔總執行個體的佔比，到達該佔比時任務自動暫停。取值範圍：1 ～100 （%）。說明需要從小到大設定，且最後一個進度百分比需要為 100。	20
CheckpointPauseTime	integer	否	當進入重新整理任務檢查點時，暫停的時長。單位：分鐘取值範圍 : 1～ 2880 預設值：60。	10
Strategy	string	否

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
InstanceRefreshTaskId	string	執行個體重新整理任務 ID。	ir-a12ds234fasd*****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "InstanceRefreshTaskId": "ir-a12ds234fasd*****"
}

錯誤碼

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

變更歷史

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