全部产品
Search

搜索本产品

    弹性伸缩：DescribeLifecycleHooks - 查询生命周期挂钩详情

    文档中心

    弹性伸缩：DescribeLifecycleHooks - 查询生命周期挂钩详情

    更新时间：Nov 11, 2024

    调用DescribeLifecycleHooks通过指定生命周期挂钩ID或伸缩组ID来查询生命周期挂钩的信息，包括等待状态结束后的下一步动作、生命周期挂钩对应的伸缩活动类型、通知对象标识符、挂起等待时间等。

    接口说明

    您可以通过以下三种方式查询生命周期挂钩：

    • 指定一个生命周期挂钩 ID 列表（LifecycleHookIds），此时将忽略伸缩组 ID（ScalingGroupId）和生命周期挂钩名称（LifecycleHookName）参数。

    • 指定伸缩组 ID（ScalingGroupId）。

    • 同时指定伸缩组 ID（ScalingGroupId）和生命周期挂钩名称（LifecycleHookName）。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    ess:DescribeLifecycleHooksget
    • ScalingGroup
      acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}
      无
    		无

    请求参数

    名称类型必填描述示例值
    ScalingGroupIdstring否

    伸缩组的 ID。

    		asg-bp1igpak5ft1flyp****
    LifecycleHookNamestring否

    生命周期挂钩名称。

    		lifecyclehook****
    PageNumberinteger否

    实例状态列表的页码，起始值：1。

    默认值：1。

    		1
    PageSizeinteger否

    分页查询时设置的每页行数，最大值：50。

    默认值：50。

    		50
    LifecycleHookIdsarray否

    生命周期挂钩的 ID 列表。

    string否

    生命周期挂钩的 ID。

    		ash-bp1at9ufhmcf9cmy****
    RegionIdstring否

    伸缩组所属地域的 ID。

    		cn-beijing

    返回参数

    名称类型描述示例值
    object

    查询生命周期挂钩返回信息。

    RequestIdstring

    请求 ID。

    		473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    PageNumberinteger

    查询起始页数。

    		1
    PageSizeinteger

    查询每页返回行数。

    		50
    TotalCountinteger

    生命周期挂钩总个数。

    		1
    LifecycleHooksarray<object>

    生命周期挂钩信息列表。

    LifecycleHookobject

    生命周期挂钩的信息。

    DefaultResultstring

    实例挂起等待状态结束后的下一步动作。

    		CONTINUE
    LifecycleHookIdstring

    生命周期挂钩 ID。

    		ash-bp19d1032y9kij96****
    LifecycleHookNamestring

    生命周期挂钩的名称。

    		lifecyclehook****
    LifecycleTransitionstring

    生命周期挂钩对应的伸缩活动类型。

    		SCALE_OUT
    NotificationMetadatastring

    伸缩活动的等待状态的固定字符串信息。

    		Test Lifecycle Hook.
    NotificationArnstring

    生命周期挂钩通知对象标识符，参数格式如下：

    • 未设置通知：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
    HeartbeatTimeoutinteger

    生命周期挂钩为伸缩活动设置的等待时间，等待超时后会执行下一步动作。

    		60
    ScalingGroupIdstring

    伸缩组 ID。

    		asg-bp1igpak5ft1flyp****
    LifecycleHookStatusstring

    生命周期挂钩的状态，可能值：

    • Active：启动状态。
    • InActive：暂停状态。
    		Active

    示例

    正常返回示例

    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"
    }
  ]
}

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2022-10-13OpenAPI 返回结构发生变更查看变更详情