1. 接口描述
接口请求域名: as.tencentcloudapi.com 。
本接口(DescribeLifecycleHooks)用于查询生命周期挂钩信息。
- 可以根据伸缩组ID、生命周期挂钩ID或者生命周期挂钩名称等信息来查询生命周期挂钩的详细信息。过滤信息详细请见过滤器
Filter
。 - 如果参数为空,返回当前用户一定数量(
Limit
所指定的数量,默认为20)的生命周期挂钩。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeLifecycleHooks。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
LifecycleHookIds.N | 否 | Array of String | 按照一个或者多个生命周期挂钩ID查询。生命周期挂钩ID形如:ash-8azjzxcl 。每次请求的上限为100。参数不支持同时指定LifecycleHookIds 和Filters 。示例值:["ash-mzdlwrbt"], |
Filters.N | 否 | Array of Filter | 过滤条件。 每次请求的 Filters 的上限为10,Filter.Values 的上限为5。参数不支持同时指定LifecycleHookIds 和Filters 。示例值:[{"Name": "auto-scaling-group-id", "Values": ["asg-0xrkdurh"]}] |
Limit | 否 | Integer | 返回数量,默认为20,最大值为100。关于Limit 的更进一步介绍请参考 API 简介中的相关小节。示例值:20 |
Offset | 否 | Integer | 偏移量,默认为0。关于Offset 的更进一步介绍请参考 API 简介中的相关小节。示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
LifecycleHookSet | Array of LifecycleHook | 生命周期挂钩数组 示例值:[{"LifecycleTransitionType": "EXTENSION", "HeartbeatTimeout": 180, "AutoScalingGroupId": "asg-mzlvwxtj", "LifecycleCommand": {"CommandId": "", "Parameters": ""}, "LifecycleHookName": "plasdd", "NotificationMetadata": "", "NotificationTarget": {"TargetType": "", "EnvironmentId": "", "ClusterId": "", "TopicName": "", "QueueName": ""}, "CreatedTime": "2024-10-09T09:00:21Z", "DefaultResult": "CONTINUE", "LifecycleHookId": "ash-06d46xsc", "LifecycleTransition": "INSTANCE_TERMINATING"}] |
TotalCount | Integer | 总体数量 示例值:4 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询生命周期挂钩
输入示例
POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLifecycleHooks
<公共请求参数>
{}
输出示例
{
"Response": {
"TotalCount": 1,
"LifecycleHookSet": [
{
"LifecycleHookName": "terminate-topic",
"LifecycleTransitionType": "NORMAL",
"AutoScalingGroupId": "asg-8fbozqja",
"HeartbeatTimeout": 120,
"NotificationMetadata": "topic",
"NotificationTarget": {
"TargetType": "TDMQ_TOPIC",
"TopicName": "one-topic",
"QueueName": "as-tdmq-queue"
},
"LifecycleCommand": {
"CommandId": "cmd-hyg5r4e3",
"Parameters": "{123: 222}"
},
"CreatedTime": "2019-04-19T02:59:30Z",
"DefaultResult": "ABANDON",
"LifecycleHookId": "ash-oq76wsrx",
"LifecycleTransition": "INSTANCE_TERMINATING"
}
],
"RequestId": "dff07f6e-bdbc-4532-baeb-e7fb3aebe248"
}
}
示例2 查询生命周期挂钩,使用Filter
输入示例
POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLifecycleHooks
<公共请求参数>
{
"Filters": [
{
"Values": [
"asg-8fbozqja"
],
"Name": "auto-scaling-group-id"
},
{
"Values": [
"ash-fbjiexz7"
],
"Name": "lifecycle-hook-id"
}
]
}
输出示例
{
"Response": {
"TotalCount": 1,
"LifecycleHookSet": [
{
"LifecycleHookName": "launch-queue",
"LifecycleTransitionType": "NORMAL",
"AutoScalingGroupId": "asg-8fbozqja",
"HeartbeatTimeout": 120,
"NotificationMetadata": "queue",
"NotificationTarget": {
"TargetType": "TDMQ_QUEUE",
"TopicName": "as-topic-0",
"QueueName": "one-queue"
},
"LifecycleCommand": {
"CommandId": "cmd-j87y5tr4",
"Parameters": "{123: 222}"
},
"CreatedTime": "2019-04-19T02:57:14Z",
"DefaultResult": "CONTINUE",
"LifecycleHookId": "ash-fbjiexz7",
"LifecycleTransition": "INSTANCE_LAUNCHING"
}
],
"RequestId": "2d774a6c-bcaa-4805-b0cd-bd64519e2538"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ActionNotFound | 无效的Action请求。 |
InvalidParameter.Conflict | 参数冲突,指定的多个参数冲突,不能同时存在。 |
InvalidParameterValue.InvalidAutoScalingGroupId | 伸缩组ID无效。 |
InvalidParameterValue.InvalidFilter | 过滤条件无效。 |
InvalidParameterValue.InvalidLifecycleHookId | 生命周期挂钩ID无效。 |
MissingParameter | 缺少参数错误。 |