1. 接口描述
接口请求域名: scf.tencentcloudapi.com 。
支持触发器配置更新。
默认接口请求频率限制:20次/秒
注意:目前只支持timer触发器和ckafka触发器更新!
timer触发器和ckafka触发器支持更新字段有:Enable、TriggerDesc、Description、CustomArgument。
timer触发器TriggerDesc支持5段式和7段式的更新。
ckafka触发器TriggerDesc支持Retry、MaxMsgNum、TimeOut参数更新,不传值表示原值不变,传值不能为空。
Enable 触发器开启或关闭,传参为OPEN为开启,CLOSE为关闭。不传值表示原值不变,传值不能为空。
Description 触发器描述,不传值保持原值不变,传值为空则为空。
CustomArgument 触发器用户附加信息(注意:只有timer触发器展示),不传值保持原值不变,传值为空则为空。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:UpdateTrigger。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
FunctionName | 是 | String | 函数名称 示例值:FuncName |
TriggerName | 是 | String | 触发器名称 示例值:TriggerName |
Type | 是 | String | 触发器类型,目前只支持timer、ckafka、http三种类型 示例值:timer |
Enable | 否 | String | 触发器开启或关闭,传参为OPEN为开启,CLOSE为关闭 示例值:OPEN |
Qualifier | 否 | String | 触发器创建时所指向的函数版本或别名,默认为 $LATEST 示例值:$DEFAULT |
Namespace | 否 | String | 函数的命名空间,默认值为default 示例值:default |
TriggerDesc | 否 | String | TriggerDesc参数 示例值:*/1 * * * * * * |
Description | 否 | String | 触发器描述 示例值:some description |
CustomArgument | 否 | String | 用户附加信息 示例值:custom information |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 接口调用示例
接口调用示例
输入示例
POST / HTTP/1.1
Host: scf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateTrigger
<公共请求参数>
{
"Enable": "CLOSE",
"FunctionName": "helloworld-xxxxxxxx",
"TriggerName": "\t\nSCF-timer-xxxxxxxx",
"Type": "timer",
"Qualifier": "$DEFAULT",
"Namespace": "default",
"TriggerDesc": "0 0 0 */2 * * *",
"Description": "some description",
"CustomArgument": "中文测试"
}
输出示例
{
"Response": {
"RequestId": "375d4028-xxxx-xxxxf-xxxx-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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.CreateTrigger | 当前函数状态无法进行此操作。 |
FailedOperation.UpdateTrigger | 更新触发器出错。 |
InternalError.Cmq | 删除cmq触发器失败。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Action | Action取值与规范不符,请修正后再试。可参考:https://cloud.tencent.com/document/product/583/17235。 |
InvalidParameterValue.Description | Description传入错误。 |
InvalidParameterValue.Enable | Enable取值与规范不符,请修正后再试。 |
InvalidParameterValue.FunctionName | 函数不存在。 |
InvalidParameterValue.TriggerDesc | TriggerDesc传入参数错误。 |
InvalidParameterValue.TriggerName | TriggerName传入错误。 |
InvalidParameterValue.Type | Type传入错误。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.Function | 函数不存在。 |
ResourceNotFound.FunctionName | 函数不存在。 |
ResourceNotFound.Namespace | Namespace不存在。 |
ResourceNotFound.Qualifier | 版本不存在。 |
ResourceNotFound.Trigger | 触发器不存在。 |
UnauthorizedOperation.CAM | CAM鉴权失败。 |