弹性伸缩修改生命周期挂钩-API 文档-文档中心-腾讯云

1. 接口描述

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

此接口用于修改生命周期挂钩。

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

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyLifecycleHook。
Version	是	String	公共参数，本接口取值：2018-04-19。
Region	是	String	公共参数，详见产品支持的地域列表。
LifecycleHookId	是	String	生命周期挂钩ID。示例值：ash-je1esoo9
LifecycleHookName	否	String	生命周期挂钩名称。示例值：hook-test
LifecycleTransition	否	String	进入生命周期挂钩场景，取值包括： INSTANCE_LAUNCHING：实例启动后 INSTANCE_TERMINATING：实例销毁前示例值：INSTANCE_LAUNCHING
DefaultResult	否	String	定义伸缩组在生命周期挂钩超时的情况下应采取的操作，取值包括： CONTINUE：超时后继续伸缩活动 ABANDON：超时后终止伸缩活动示例值：CONTINUE
HeartbeatTimeout	否	Integer	生命周期挂钩超时之前可以经过的最长时间（以秒为单位），范围从 30 到 7200 秒。示例值：30
NotificationMetadata	否	String	弹性伸缩向通知目标发送的附加信息。示例值：addtional-info
LifecycleTransitionType	否	String	进行生命周期挂钩的场景类型，取值范围包括`NORMAL`和 `EXTENSION`。说明：设置为`EXTENSION`值，在AttachInstances、DetachInstances、RemoveInstances 接口时会触发生命周期挂钩操作，值为`NORMAL`则不会在这些接口中触发生命周期挂钩。示例值：NORMAL
NotificationTarget	否	NotificationTarget	通知目标信息。示例值：{"QueueName": "as-pool", "TargetType": "TDMQ_CMQ_QUEUE"}
LifecycleCommand	否	LifecycleCommand	远程命令执行对象。示例值：{"CommandId": "cmd-am4e3hd8", "Parameters": "{123: 222}"}

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改生命周期挂钩至实例启动后进入挂钩时间

输入示例

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

{
    "LifecycleHookId": "ash-je1esoo9",
    "LifecycleTransition": "INSTANCE_LAUNCHING"
}

输出示例

{
    "Response": {
        "RequestId": "4942c041-fc7f-4f50-b489-d01cdeb6638f"
    }
}

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. 错误码

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

错误码	描述
InternalError.CallTATError	TAT 接口调用失败。
InvalidParameter	参数错误。
InvalidParameter.ActionNotFound	无效的Action请求。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.Range	取值超出指定范围。
ResourceNotFound.CmqQueueNotFound	指定的 CMQ queue 不存在。
ResourceNotFound.CommandNotFound	命令不存在。
ResourceNotFound.LifecycleHookNotFound	无法找到指定生命周期挂钩。
ResourceNotFound.TDMQCMQQueueNotFound	TDMQ-CMQ 队列不存在。
ResourceNotFound.TDMQCMQTopicNotFound	TDMQ-CMQ 主题不存在。
ResourceUnavailable.TDMQCMQTopicHasNoSubscriber	TDMQ-CMQ 主题无订阅者。

修改生命周期挂钩

本页目录：