查询生命周期挂钩

最近更新时间: 2026-09-17 00:04:45

1. 接口描述

接口请求域名： as.api3.fincloud.tencent.cn。

本接口（DescribeLifecycleHooks）用于查询生命周期挂钩信息。

可以根据伸缩组ID、生命周期挂钩ID或者生命周期挂钩名称等信息来查询生命周期挂钩的详细信息。过滤信息详细请见过滤器Filter。
如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的生命周期挂钩。

默认接口请求频率限制：20次/秒。

接口更新时间：2019-10-31 18:30:12。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeLifecycleHooks
Version	是	否	String	公共参数，本接口取值：2018-04-19
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
LifecycleHookIds	否	否	Array of String	按照一个或者多个生命周期挂钩ID查询。生命周期挂钩ID形如：`ash-8azjzxcl`。每次请求的上限为100。参数不支持同时指定`LifecycleHookIds`和`Filters`。示例值： ["ash-8azjzxcl"]
Filters	否	否	Array of Filter	过滤条件。 lifecycle-hook-id - String - 是否必填：否 -（过滤条件）按照生命周期挂钩ID过滤。 lifecycle-hook-name - String - 是否必填：否 -（过滤条件）按照生命周期挂钩名称过滤。 auto-scaling-group-id - String - 是否必填：否 -（过滤条件）按照伸缩组ID过滤。过滤条件。 lifecycle-hook-id - String - 是否必填：否 -（过滤条件）按照生命周期挂钩ID过滤。 lifecycle-hook-name - String - 是否必填：否 -（过滤条件）按照生命周期挂钩名称过滤。 auto-scaling-group-id - String - 是否必填：否 -（过滤条件）按照伸缩组ID过滤。每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`LifecycleHookIds `和`Filters`。示例值：查看
Limit	否	否	Uint64	返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API 简介中的相关小节。示例值： 1
Offset	否	否	Uint64	偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API 简介中的相关小节。示例值： 0

3. 输出参数

参数名称	类型	描述
LifecycleHookSet	Array of LifecycleHook	生命周期挂钩数组示例值：查看
TotalCount	Int64	总体数量示例值： 4
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter.Conflict	参数冲突，指定的多个参数冲突，不能同时存在。
InvalidParameter	参数错误。
MissingParameter	缺少参数错误
InvalidFilter	无效的过滤器。
InternalError	内部错误

5. 示例

示例1 查询生命周期挂钩，使用Filter

输入示例

https://as.api3.fincloud.tencent.cn/?Action=DescribeLifecycleHooks
&Filters.0.Name=lifecycle-hook-id
&Filters.0.Values.0=ash-oq76wsrx
&Filters.0.Values.1=ash-fbjiexz7
&Filters.1.Name=auto-scaling-group-id
&Filters.1.Values.0=asg-8fbozqja
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 2,
        "LifecycleHookSet": [
            {
                "LifecycleHookName": "terminate-topic",
                "AutoScalingGroupId": "asg-8fbozqja",
                "HeartbeatTimeout": 120,
                "NotificationMetadata": "topic",
                "NotificationTarget": {
                    "TargetType": "CMQ_TOPIC",
                    "TopicName": "one-topic",
                    "QueueName": ""
                },
                "CreatedTime": "2019-04-19T02:59:30Z",
                "DefaultResult": "ABANDON",
                "LifecycleHookId": "ash-oq76wsrx",
                "LifecycleTransition": "INSTANCE_TERMINATING"
            },
            {
                "LifecycleHookName": "launch-queue",
                "AutoScalingGroupId": "asg-8fbozqja",
                "HeartbeatTimeout": 120,
                "NotificationMetadata": "queue",
                "NotificationTarget": {
                    "TargetType": "CMQ_QUEUE",
                    "TopicName": "",
                    "QueueName": "one-queue"
                },
                "CreatedTime": "2019-04-19T02:57:14Z",
                "DefaultResult": "CONTINUE",
                "LifecycleHookId": "ash-fbjiexz7",
                "LifecycleTransition": "INSTANCE_LAUNCHING"
            }
        ],
        "RequestId": "2d774a6c-bcaa-4805-b0cd-bd64519e2538"
    }
}

示例2 查询生命周期挂钩

输入示例

https://as.api3.fincloud.tencent.cn/?Action=DescribeLifecycleHooks
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 4,
        "LifecycleHookSet": [
            {
                "LifecycleHookName": "terminate-topic",
                "AutoScalingGroupId": "asg-8fbozqja",
                "HeartbeatTimeout": 120,
                "NotificationMetadata": "topic",
                "NotificationTarget": {
                    "TargetType": "CMQ_TOPIC",
                    "TopicName": "one-topic",
                    "QueueName": ""
                },
                "CreatedTime": "2019-04-19T02:59:30Z",
                "DefaultResult": "ABANDON",
                "LifecycleHookId": "ash-oq76wsrx",
                "LifecycleTransition": "INSTANCE_TERMINATING"
            },
            {
                "LifecycleHookName": "launch-queue",
                "AutoScalingGroupId": "asg-8fbozqja",
                "HeartbeatTimeout": 120,
                "NotificationMetadata": "queue",
                "NotificationTarget": {
                    "TargetType": "CMQ_QUEUE",
                    "TopicName": "",
                    "QueueName": "one-queue"
                },
                "CreatedTime": "2019-04-19T02:57:14Z",
                "DefaultResult": "CONTINUE",
                "LifecycleHookId": "ash-fbjiexz7",
                "LifecycleTransition": "INSTANCE_LAUNCHING"
            },
            {
                "LifecycleHookName": "one-hook",
                "AutoScalingGroupId": "asg-8fbozqja",
                "HeartbeatTimeout": 360,
                "NotificationMetadata": "",
                "NotificationTarget": {
                    "TargetType": "",
                    "TopicName": "",
                    "QueueName": ""
                },
                "CreatedTime": "2019-04-19T02:56:02Z",
                "DefaultResult": "CONTINUE",
                "LifecycleHookId": "ash-heyubibl",
                "LifecycleTransition": "INSTANCE_LAUNCHING"
            },
            {
                "LifecycleHookName": "one-hook-default",
                "AutoScalingGroupId": "asg-8fbozqja",
                "HeartbeatTimeout": 300,
                "NotificationMetadata": "",
                "NotificationTarget": {
                    "TargetType": "",
                    "TopicName": "",
                    "QueueName": ""
                },
                "CreatedTime": "2019-04-19T02:51:24Z",
                "DefaultResult": "CONTINUE",
                "LifecycleHookId": "ash-8azjzxj9",
                "LifecycleTransition": "INSTANCE_LAUNCHING"
            }
        ],
        "RequestId": "dff07f6e-bdbc-4532-baeb-e7fb3aebe248"
    }
}