租户端 计算 弹性伸缩（AS） 生命周期钩子相关接口 查询生命周期挂钩

查询生命周期挂钩

最近更新时间: 2026-08-29 00:19:45

1. 接口描述

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

本接口（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 内部错误