ModifyLifecycleHook - 修改一個生命週期掛鈎的資訊 - Auto Scaling

如果當前伸縮組的生命週期掛鈎不能滿足業務需求，您無需做刪除操作，調用ModifyLifecycleHook，通過待修改生命週期掛鈎的ID或名稱，伸縮組的ID等參數，修改一個生命週期掛鈎的資訊，包括生命週期掛鈎適用的伸縮活動類型，生命週期掛鈎為伸縮組活動設定的等待時間，等待狀態結束後的下一步動作等資訊。

介面說明

您可以通過以下兩種方式指定待修改的生命週期掛鈎：

只指定生命週期掛鈎 ID（LifecycleHookId），此時將忽略伸縮組 ID（ScalingGroupId）和生命週期掛鈎名稱（LifecycleHookName）參數。
同時指定伸縮組 ID（ScalingGroupId）與生命週期掛鈎名稱（LifecycleHookName），因為在一個伸縮組內同一個生命週期掛鈎名稱是唯一的。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ess:ModifyLifecycleHook

update

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

無

請求參數

名稱	類型	必填	描述	樣本值
LifecycleHookId	string	否	待修改生命週期掛鈎的 ID，用於指定生命週期掛鈎。	ash-bp1fxuqyi98w0aib****
ScalingGroupId	string	否	伸縮組的 ID，用於指定生命週期掛鈎。	asg-bp18p2yfxow2dloq****
LifecycleHookName	string	否	待修改生命週期掛鈎的名稱，用於指定生命週期掛鈎。	test_SCAL****
DefaultResult	string	否	等待狀態結束後的下一步動作，取值範圍： CONTINUE：繼續響應彈性擴張活動或者繼續響應彈性收縮活動。 ABANDON：直接釋放彈性擴張活動建立出來的 ECS 執行個體或者直接將彈性收縮活動中的 ECS 執行個體從伸縮組移除。 ROLLBACK：針對彈性收縮活動，會拒絕釋放 ECS 執行個體，進行復原；針對彈性擴張活動，會直接釋放建立出來的 ECS 執行個體，效果同 ABANDON 一樣。當伸縮組發生彈性收縮活動（SCALE_IN）並觸發多個生命週期掛鈎時，如果一個生命週期掛鈎的 DefaultResult 取值為 ABANDON 或 ROLLBACK，且該掛鈎等待狀態結束時，會提前將其他生命週期掛鈎對應的等待狀態提前結束。其他情況下，下一步動作均以最後一個結束等待狀態的下一步動作為準。	CONTINUE
HeartbeatTimeout	integer	否	生命週期掛鈎為伸縮組活動設定的等待時間，等待狀態逾時後會執行下一步動作。取值範圍：30~21600，單位：秒。您可以調用 RecordLifecycleActionHeartbeat 延長 ECS 執行個體的等待時間，也可以調用 CompleteLifecycleAction 提前結束伸縮活動的等待狀態。	600
LifecycleTransition	string	否	生命週期掛鈎適用的伸縮活動類型，取值範圍： SCALE_OUT：伸縮組彈性擴張活動。 SCALE_IN：伸縮組彈性收縮活動。	SCALE_IN
NotificationMetadata	string	否	伸縮活動的等待狀態的固定字串資訊。參數長度不能超過 4096 個字元。 Auto Scaling每次推送訊息到通知對象時，會同時發送您預先指定的 NotificationMetadata 參數值，便於管理和標記不同類別的通知資訊。當您同時指定了 NotificationArn 參數時，NotificationMetadata 參數方可生效。	Test
NotificationArn	string	否	生命週期掛鈎通知物件識別碼，設定本參數時支援以下通知方式： MNS 隊列，參數取值格式：acs:mns:{region-id}:{account-id}:queue/{queuename}。 MNS 主題，參數取值格式：acs:mns:{region-id}:{account-id}:topic/{topicname}。 OOS 模板，參數取值格式：acs:oos:{region-id}:{account-id}:template/{templatename}。事件匯流排，參數取值格式：acs:eventbridge:{region-id}:{account-id}:eventbus/default。參數格式中的變數含義如下： region-id：伸縮組所在的地區的 ID。 account-id：阿里雲帳號 ID。 queuename：MNS 隊列的名稱。 topicname：MNS 主題的名稱。 templatename：OOS 模板的名稱。	acs:mns:cn-beijing:161456884340**:queue/modifyLifecycleHo**
RegionId	string	否	伸縮組所屬的地區 ID。	cn-beijing
LifecycleHookStatus	string	否	修改當前生命週期掛鈎的狀態，取值範圍： Active：表示啟動生命週期掛鈎。 InActive：表示暫停生命週期掛鈎。如果不設定該參數，則當前生命週期掛鈎狀態保持為原有狀態。說明生命週期掛鈎建立成功後，系統預設為啟動狀態。	Active

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

錯誤碼

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

變更歷史

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