1. 接口描述
接口请求域名: as.tencentcloudapi.com 。
本接口(DescribeLifecycleHooks)用于查询生命周期挂钩信息。
- 可以根据伸缩组ID、生命周期挂钩ID或者生命周期挂钩名称等信息来查询生命周期挂钩的详细信息。过滤信息详细请见过滤器
Filter
。 - 如果参数为空,返回当前用户一定数量(
Limit
所指定的数量,默认为20)的生命周期挂钩。
默认接口请求频率限制:20次/秒。
注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:as.ap-shanghai-fsi.tencentcloudapi.com。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeLifecycleHooks。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
LifecycleHookIds.N | 否 | Array of String | 按照一个或者多个生命周期挂钩ID查询。生命周期挂钩ID形如:ash-8azjzxcl 。每次请求的上限为100。参数不支持同时指定LifecycleHookIds 和Filters 。 |
Filters.N | 否 | Array of Filter | 过滤条件。 过滤条件。 每次请求的 Filters 的上限为10,Filter.Values 的上限为5。参数不支持同时指定LifecycleHookIds 和Filters 。 |
Limit | 否 | Integer | 返回数量,默认为20,最大值为100。关于Limit 的更进一步介绍请参考 API 简介中的相关小节。 |
Offset | 否 | Integer | 偏移量,默认为0。关于Offset 的更进一步介绍请参考 API 简介中的相关小节。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
LifecycleHookSet | Array of LifecycleHook | 生命周期挂钩数组 |
TotalCount | Integer | 总体数量 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询生命周期挂钩
输入示例
https://as.tencentcloudapi.com/?Action=DescribeLifecycleHooks
&<公共请求参数>
输出示例
{
"Response": {
"TotalCount": 4,
"LifecycleHookSet": [
{
"LifecycleHookName": "terminate-topic",
"LifecycleTransitionType": "NORMAL",
"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",
"LifecycleTransitionType": "NORMAL",
"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",
"LifecycleTransitionType": "NORMAL",
"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",
"LifecycleTransitionType": "NORMAL",
"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"
}
}
示例2 查询生命周期挂钩,使用Filter
输入示例
https://as.tencentcloudapi.com/?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",
"LifecycleTransitionType": "NORMAL",
"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",
"LifecycleTransitionType": "NORMAL",
"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"
}
}
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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
- Tencent Cloud CLI 3.0
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.Conflict | 参数冲突,指定的多个参数冲突,不能同时存在。 |
InvalidParameterValue.InvalidAutoScalingGroupId | 伸缩组ID无效。 |
InvalidParameterValue.InvalidFilter | 过滤条件无效。 |
InvalidParameterValue.InvalidLifecycleHookId | 生命周期挂钩ID无效。 |
MissingParameter | 缺少参数错误。 |