DescribeLifecycleHooks - Auto Scaling

呼叫DescribeLifecycleHooks透過指定生命週期掛鉤ID或伸縮群組ID來查詢生命週期掛鉤的資訊，包括等待狀態結束後的下一步動作、生命週期掛鉤對應的伸縮活動類型、通知物件識別碼、掛起等待時間等。

介面說明

您可以透過以下三種方式查詢生命週期掛鉤：

指定一個生命週期掛鉤 ID 清單（LifecycleHookId.N），此時將忽略伸縮群組 ID（ScalingGroupId）和生命週期掛鉤名稱（LifecycleHookName）參數。
指定伸縮群組 ID（ScalingGroupId）。
同時指定伸縮群組 ID（ScalingGroupId）和生命週期掛鉤名稱（LifecycleHookName）。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ess:DescribeLifecycleHooks

get

*ScalingGroup

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

無

請求參數

名稱	類型	必填	描述	樣本值
ScalingGroupId	string	否	伸縮群組的 ID。	asg-bp1igpak5ft1flyp****
LifecycleHookName	string	否	生命週期掛鉤的名稱。	lifecyclehook****
PageNumber	integer	否	生命週期掛鉤清單的頁碼，起始值：1。預設值：1。	1
PageSize	integer	否	分頁查詢時設定的每頁行數，最大值：50。預設值：50。	50
LifecycleHookId	array	否	生命週期掛鉤的 ID 清單。	ash-bp19d1032y9kij96****
	string	否	生命週期掛鉤的 ID。	ash-bp1at9ufhmcf9cmy****
RegionId	string	否	伸縮群組所屬地域的 ID。	cn-beijing

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	查詢起始頁數。	1
PageSize	integer	查詢每頁傳回行數。	50
TotalCount	integer	生命週期掛鉤總個數。	1
LifecycleHooks	object
LifecycleHook	array<object>	生命週期掛鉤資訊清單。
	object	生命週期掛鉤資訊。
DefaultResult	string	執行個體掛起等待狀態結束後的下一步動作。	CONTINUE
LifecycleHookId	string	生命週期掛鉤 ID。	ash-bp19d1032y9kij96****
LifecycleHookName	string	生命週期掛鉤名稱。	lifecyclehook****
LifecycleTransition	string	生命週期掛鉤對應的伸縮活動類型。	SCALE_OUT
NotificationMetadata	string	伸縮活動的等待狀態的固定字串資訊。	Test Lifecycle Hook.
NotificationArn	string	生命週期掛鉤通知物件識別碼，參數格式如下：未設定通知：`acs:ess:{region-id}:{account-id}:null/null`。 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:ess:cn-beijing:161456884340****:null/null
HeartbeatTimeout	integer	生命週期掛鉤為伸縮活動設定的等待時間，等待逾時後會執行下一步動作。	60
ScalingGroupId	string	伸縮群組 ID。	asg-bp1igpak5ft1flyp****
LifecycleHookStatus	string	生命週期掛鉤的狀態，可選值： Active：啟用狀態。 InActive：未啟用狀態。	Active

樣本

正常返回樣本

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "PageSize": 50,
  "TotalCount": 1,
  "LifecycleHooks": {
    "LifecycleHook": [
      {
        "DefaultResult": "CONTINUE",
        "LifecycleHookId": "ash-bp19d1032y9kij96****",
        "LifecycleHookName": "lifecyclehook****",
        "LifecycleTransition": "SCALE_OUT",
        "NotificationMetadata": "Test Lifecycle Hook.",
        "NotificationArn": "acs:ess:cn-beijing:161456884340****:null/null",
        "HeartbeatTimeout": 60,
        "ScalingGroupId": "asg-bp1igpak5ft1flyp****",
        "LifecycleHookStatus": "Active"
      }
    ]
  }
}

錯誤碼

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

變更歷史

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