全部產品
Search
文件中心

Auto Scaling:DescribeLifecycleHooks

更新時間:Jan 14, 2025

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

介面說明

您可以通過以下三種方式查詢生命週期掛鈎:

  • 指定一個生命週期掛鈎ID列表(LifecycleHookId.N),此時將忽略伸縮組ID(ScalingGroupId)和生命週期掛鈎名稱(LifecycleHookName)參數。
  • 指定伸縮組ID(ScalingGroupId)。
  • 同時指定伸縮組ID(ScalingGroupId)和生命週期掛鈎名稱(LifecycleHookName)。

調試

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

請求參數

名稱

類型

是否必選

樣本值

描述

Action String DescribeLifecycleHooks

系統規定參數。取值:DescribeLifecycleHooks

ScalingGroupId String asg-bp1igpak5ft1flyp****

伸縮組的ID。

LifecycleHookName String lifecyclehook****

生命週期掛鈎的名稱。

PageNumber Integer 1

執行個體狀態列表的頁碼,起始值:1。

預設值:1。

PageSize Integer 50

分頁查詢時設定的每頁行數,最大值:50。

預設值:50。

LifecycleHookId.N String ash-bp1at9ufhmcf9cmy****

生命週期掛鈎的ID。

RegionId String cn-beijing

伸縮組所屬地區的ID。

返回資料

名稱

類型

樣本值

描述

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

請求ID。

PageNumber Integer 1

查詢起始頁數。

PageSize Integer 50

查詢每頁返回行數。

TotalCount Integer 1

生命週期掛鈎總個數。

LifecycleHooks Array of LifecycleHook

生命週期掛鈎資訊列表。

LifecycleHook
DefaultResult String CONTINUE

執行個體掛起等待狀態結束後的下一步動作。

LifecycleHookId String ash-bp19d1032y9kij96****

生命週期掛鈎ID。

LifecycleHookName String lifecyclehook****

生命週期掛鈎名稱。

LifecycleTransition String SCALE_OUT

生命週期掛鈎對應的伸縮活動類型。

NotificationMetadata String Test Lifecycle Hook.

伸縮活動的等待狀態的固定字串資訊。

NotificationArn String acs:ess:cn-beijing:161456884340****:null/null

生命週期掛鈎通知物件識別碼,參數格式如下:

  • 未設定通知: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模板的名稱。
HeartbeatTimeout Integer 60

生命週期掛鈎為伸縮活動設定的等待時間,等待逾時後會執行下一步動作。

ScalingGroupId String asg-bp1igpak5ft1flyp****

伸縮組ID。

LifecycleHookStatus String Active

生命週期掛鈎的狀態,可選值:

  • Active:啟動狀態。
  • InActive:暫停狀態。

樣本

請求樣本

http(s)://ess.aliyuncs.com/?Action=DescribeLifecycleHooks
&ScalingGroupId=asg-bp1igpak5ft1flyp****
&LifecycleHookName=lifecyclehook****
&PageNumber=1
&PageSize=50
&LifecycleHookId=["ash-bp1at9ufhmcf9cmy****"]
&RegionId=cn-beijing
&公用請求參數

正常返回樣本

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber" : 1,
  "PageSize" : 50,
  "TotalCount" : 1,
  "LifecycleHooks" : [ {
    "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"
  } ]
}

錯誤碼

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

HttpCode

錯誤碼

錯誤資訊

描述

400

InvalidParamter

The specified value of parameter is not valid.

指定的參數值不合法。