升级生命周期挂钩

最近更新时间:2019-05-16 19:39:23

1. 接口描述

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

本接口(UpgradeLifecycleHook)用于升级生命周期挂钩。

  • 本接口用于升级生命周期挂钩,采用“完全覆盖”风格,无论之前参数如何,统一按照接口参数设置为新的配置。对于非必填字段,不填写则按照默认值赋值。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:as.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:UpgradeLifecycleHook
Version String 公共参数,本接口取值:2018-04-19
Region String 公共参数,详见产品支持的 地域列表
LifecycleHookId String 生命周期挂钩ID
LifecycleHookName String 生命周期挂钩名称
LifecycleTransition String 进行生命周期挂钩的场景,取值范围包括“INSTANCE_LAUNCHING”和“INSTANCE_TERMINATING”
DefaultResult String 定义伸缩组在生命周期挂钩超时的情况下应采取的操作,取值范围是“CONTINUE”或“ABANDON”,默认值为“CONTINUE”
HeartbeatTimeout Integer 生命周期挂钩超时之前可以经过的最长时间(以秒为单位),范围从30到3600秒,默认值为300秒
NotificationMetadata String 弹性伸缩向通知目标发送的附加信息,默认值为''
NotificationTarget NotificationTarget 通知目标

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 升级生命周期挂钩

输入示例

https://as.tencentcloudapi.com/?Action=UpgradeLifecycleHook
&LifecycleHookId=ash-8azjzxj9
&DefaultResult=CONTINUE
&HeartbeatTimeout=240
&LifecycleHookName=hook-updated
&LifecycleTransition=INSTANCE_LAUNCHING
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "db656d36-ed6b-4795-bdc4-94e7a7e04acb"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误
InvalidParameter 参数错误。
InvalidParameter.Conflict 参数冲突,指定的多个参数冲突,不能同时存在。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.Filter 无效的过滤器。
InvalidParameterValue.LifecycleHookNameDuplicated 生命周期挂钩名称重复。
MissingParameter 缺少参数错误
ResourceNotFound.LifecycleHookNotFound 无法找到指定生命周期挂钩。