完成生命周期动作

最近更新时间:2024-11-13 01:09:34

我的收藏

1. 接口描述

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

本接口(CompleteLifecycleAction)用于完成生命周期动作。

  • 用户通过调用本接口,指定一个具体的生命周期挂钩的结果(“CONITNUE”或者“ABANDON”)。如果一直不调用本接口,则生命周期挂钩会在超时后按照“DefaultResult”进行处理。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CompleteLifecycleAction。
Version String 公共参数,本接口取值:2018-04-19。
Region String 公共参数,详见产品支持的 地域列表
LifecycleHookId String 生命周期挂钩ID
示例值:ash-fbjiexz7
LifecycleActionResult String 生命周期动作的结果,取值范围为“CONTINUE”或“ABANDON”
示例值:CONTINUE
InstanceId String 实例ID,“InstanceId”和“LifecycleActionToken”必须填充其中一个
示例值:ins-ni8bpmve
LifecycleActionToken String “InstanceId”和“LifecycleActionToken”必须填充其中一个
示例值:34b59a82-6435-4516-90db-c98aeb46769b

3. 输出参数

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

4. 示例

示例1 完成生命周期动作,通过InstanceId调用

通过InstanceId参数,完成指定实例的生命周期挂钩

输入示例

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

{
    "InstanceId": "ins-ni8bpmve",
    "LifecycleActionResult": "CONTINUE",
    "LifecycleHookId": "ash-fbjiexz7"
}

输出示例

{
    "Response": {
        "RequestId": "d0cf47b9-4236-491c-bfab-106947198afe"
    }
}

示例2 完成生命周期动作,通过LifecycleActionToken调用

通过LifecycleActionToken参数,完成指定实例的生命周期挂钩,生命周期挂钩发送给TDMQ的通知消息中包含LifecycleActionToken参数

输入示例

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

{
    "LifecycleActionResult": "CONTINUE",
    "LifecycleHookId": "ash-fbjiexz7",
    "LifecycleActionToken": "4d910016-2590-444d-8f4a-c14940036902"
}

输出示例

{
    "Response": {
        "RequestId": "de792ffe-e37e-4f1d-8534-300b555739da"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.ActionNotFound 无效的Action请求。
InvalidParameter.Conflict 参数冲突,指定的多个参数冲突,不能同时存在。
InvalidParameter.MustOneParameter 参数缺失,两种参数之中必须指定其中一个。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.InvalidInstanceId 实例ID无效。
InvalidParameterValue.InvalidLifecycleHookId 生命周期挂钩ID无效。
ResourceNotFound.LifecycleHookInstanceNotFound 生命周期挂钩对应实例不存在。
ResourceNotFound.LifecycleHookNotFound 无法找到指定生命周期挂钩。
ResourceNotFound.LifecycleHookTokenNotFound 指定的生命周期挂钩Token不存在。
ResourceUnavailable.LifecycleActionResultHasSet 生命周期动作已经被设置。