创建生命周期挂钩

1. 接口描述

接口请求域名： as.tencentcloudapi.com 。

本接口（CreateLifecycleHook）用于创建生命周期挂钩。

• 您可以为生命周期挂钩配置消息通知或执行自动化助手命令。

如果您配置了通知消息，弹性伸缩会通知您的TDMQ消息队列，通知内容形如：

{
    "Service": "Tencent Cloud Auto Scaling",
    "Time": "2019-03-14T10:15:11Z",
    "AppId": "1251783334",
    "ActivityId": "asa-fznnvrja",
    "AutoScalingGroupId": "asg-rrrrtttt",
    "LifecycleHookId": "ash-xxxxyyyy",
    "LifecycleHookName": "my-hook",
    "LifecycleActionToken": "3080e1c9-0efe-4dd7-ad3b-90cd6618298f",
    "InstanceId": "ins-aaaabbbb",
    "LifecycleTransition": "INSTANCE_LAUNCHING",
    "NotificationMetadata": ""
}

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 创建生命周期挂钩

创建生命周期挂钩，在实例创建场景下生效，DefaultResult设置为ABANDON，HeartbeatTimeout设置为360秒。

输入示例

POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLifecycleHook
<公共请求参数>

{
    "AutoScalingGroupId": "asg-8fbozqja",
    "DefaultResult": "ABANDON",
    "LifecycleHookName": "one-hook",
    "LifecycleTransition": "INSTANCE_LAUNCHING",
    "HeartbeatTimeout": "360"
}

输出示例

{
    "Response": {
        "LifecycleHookId": "ash-heyubibl",
        "RequestId": "5e414011-3359-45bd-8ba4-5b503d3fd3f6"
    }
}

示例2 创建生命周期挂钩，采用默认值

创建生命周期挂钩，在实例创建场景下生效。DefaultResult采用默认值，即CONTINUE。HeartbeatTimeout采用默认值，即300秒。

输入示例

POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLifecycleHook
<公共请求参数>

{
    "AutoScalingGroupId": "asg-8fbozqja",
    "LifecycleHookName": "one-hook-default",
    "LifecycleTransition": "INSTANCE_LAUNCHING"
}

输出示例

{
    "Response": {
        "LifecycleHookId": "ash-8azjzxj9",
        "RequestId": "4fa9fd2e-5b6c-49fe-9ba7-ed2ee62d8271"
    }
}

示例3 创建生命周期挂钩，通知TDMQ主题模型

创建生命周期挂钩，在实例销毁场景下生效，DefaultResult设置为ABANDON，HeartbeatTimeout设置为120秒，通知名为“one-topic”的TDMQ主题模型。

输入示例

POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLifecycleHook
<公共请求参数>

{
    "HeartbeatTimeout": "120",
    "AutoScalingGroupId": "asg-8fbozqja",
    "LifecycleHookName": "terminate-topic",
    "NotificationMetadata": "topic",
    "NotificationTarget": {
        "TargetType": "TDMQ_TOPIC",
        "TopicName": "one-topic"
    },
    "DefaultResult": "ABANDON",
    "LifecycleTransition": "INSTANCE_TERMINATING"
}

输出示例

{
    "Response": {
        "LifecycleHookId": "ash-oq76wsrx",
        "RequestId": "cdb7670b-0412-444f-9d2f-0da9cd07c410"
    }
}

示例4 创建生命周期挂钩，通知TDMQ队列模型

创建生命周期挂钩，在实例创建场景下生效，DefaultResult设置为CONTINUE，HeartbeatTimeout设置为120秒，通知名为“one-queue”的TDMQ队列模型。

输入示例

POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLifecycleHook
<公共请求参数>

{
    "HeartbeatTimeout": "120",
    "AutoScalingGroupId": "asg-8fbozqja",
    "LifecycleHookName": "launch-queue",
    "NotificationMetadata": "queue",
    "NotificationTarget": {
        "TargetType": "TDMQ_QUEUE",
        "QueueName": "one-queue"
    },
    "DefaultResult": "CONTINUE",
    "LifecycleTransition": "INSTANCE_LAUNCHING"
}

输出示例

{
    "Response": {
        "LifecycleHookId": "ash-fbjiexz7",
        "RequestId": "d3cf27b7-3090-4317-9107-d2eac986a446"
    }
}

示例5 创建执行自动化助手命令的生命周期挂钩

输入示例

POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLifecycleHook
<公共请求参数>

{
    "HeartbeatTimeout": "300",
    "AutoScalingGroupId": "asg-mp5ydedh",
    "LifecycleCommand": {
        "CommandId": "cmd-id9u919l",
        "Parameters": "{\"var1\":\"ck\"}"
    },
    "LifecycleHookName": "demo2",
    "DefaultResult": "CONTINUE",
    "LifecycleTransition": "INSTANCE_LAUNCHING"
}

输出示例

{
    "Response": {
        "LifecycleHookId": "ash-kjurq12y",
        "RequestId": "08f7bea5-3e0a-4280-9970-5d959a922b0b"
    }
}

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

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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