云函数更新触发器状态-API 文档-文档中心-腾讯云

1. 接口描述

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

更新触发器状态的值

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：UpdateTriggerStatus。
Version	是	String	公共参数，本接口取值：2018-04-16。
Region	是	String	公共参数，详见产品支持的地域列表。
Enable	是	String	触发器的初始是能状态OPEN表示开启 CLOSE表示关闭示例值：CLOSE
FunctionName	是	String	函数名称示例值：funcName
TriggerName	是	String	触发器名称示例值：test
Type	是	String	触发器类型，触发器类型，目前只支持 timer、 cos 、 ckafka三种类型示例值：timer
Qualifier	否	String	触发器在创建时所指向的触发别名或版本，默认值为$LATEST 示例值：$LATEST
Namespace	否	String	函数所在的命名空间，默认值为default 示例值：default
TriggerDesc	否	String	如果更新的触发器类型为 COS 触发器，该字段为必填值，存放 JSON 格式的数据 {"event":"cos:ObjectCreated:*"}，数据内容和 SetTrigger 接口中该字段的格式相同；如果更新的触发器类型为定时触发器或 CMQ 触发器，可以不指定该字段

3. 输出参数

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

4. 示例

示例1 修改触发器状态

输入示例

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

{
    "Enable": "CLOSE",
    "Type": "timer",
    "FunctionName": "<FunctionName>",
    "TriggerName": "<TriggerName>"
}

输出示例

{
    "Response": {
        "RequestId": "375d4028-2666-4cef-bcab-2331cb974fc3"
    }
}

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

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

错误码	描述
FailedOperation	操作失败。
FailedOperation.Cos	操作COS资源失败。
FailedOperation.CreateTrigger	当前函数状态无法进行此操作。
FailedOperation.UpdateStatus	更新状态操作失败。
FailedOperation.UpdateTriggerStatus	与原状态一致，无需更改。
InternalError.Cmq	删除cmq触发器失败。
InternalError.Cos	更新触发器失败。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.CosNotifyRuleConflict	COS通知规则冲突。
InvalidParameterValue.Enable	Enable取值与规范不符，请修正后再试。
InvalidParameterValue.TriggerDesc	TriggerDesc传入参数错误。
InvalidParameterValue.TriggerName	TriggerName传入错误。
InvalidParameterValue.Type	Type传入错误。
ResourceNotFound	资源不存在。
ResourceNotFound.Function	函数不存在。
ResourceNotFound.FunctionName	函数不存在。
ResourceNotFound.Namespace	Namespace不存在。
ResourceNotFound.Qualifier	版本不存在。
ResourceNotFound.Trigger	触发器不存在。
UnauthorizedOperation.CAM	CAM鉴权失败。
UnauthorizedOperation.UpdateTriggerStatus	没有权限。

更新触发器状态

本页目录：