最佳实践

设置函数触发方式

最近更新时间:2021-09-07 08:07:57

我的收藏

1. 接口描述

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

该接口根据参数输入设置新的触发方式。

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateTrigger。
Version String 公共参数,本接口取值:2018-04-16。
Region String 公共参数,详见产品支持的 地域列表
FunctionName String 新建触发器绑定的函数名称
TriggerName String 新建触发器名称。如果是定时触发器,名称支持英文字母、数字、连接符和下划线,最长100个字符;如果是cos触发器,需要是对应cos存储桶适用于XML API的访问域名(例如:5401-5ff414-12345.cos.ap-shanghai.myqcloud.com);如果是其他触发器,见具体触发器绑定参数的说明
Type String 触发器类型,目前支持 cos 、cmq、 timer、 ckafka、apigw类型。创建 cls 触发器请参考CLS 创建投递 SCF 任务
TriggerDesc String 触发器对应的参数,可见具体触发器描述说明
Namespace String 函数的命名空间
Qualifier String 函数的版本
Enable String 触发器的初始是能状态 OPEN表示开启 CLOSE表示关闭
CustomArgument String 用户自定义参数,仅支持timer触发器

3. 输出参数

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

4. 示例

示例1 创建新的触发器

用户使用该函数创建新的触发器

输入示例

https://scf.tencentcloudapi.com/?Action=CreateTrigger
&FunctionName=<FunctionName>
&TriggerName=<TriggerName>
&Type=timer
&TriggerDesc=*/2****
&<公共请求参数>

输出示例

{
  "Response": {
    "TriggerInfo": {
      "AddTime": "2021-06-09 16:07:18",
      "AvailableStatus": "Available",
      "BindStatus": "on",
      "CustomArgument": "",
      "Enable": 0,
      "ModTime": "2021-08-31 21:45:32",
      "Qualifier": "$DEFAULT",
      "ResourceId": "XXX",
      "TriggerAttribute": "single",
      "TriggerDesc": "{\"cron\":\"0 */2 * * * * *\"}",
      "TriggerName": "TriggerName",
      "Type": "timer"
    },
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.ApiGateway API网关触发器创建失败。
FailedOperation.Apigw 创建触发器失败。
FailedOperation.Cos 操作COS资源失败。
FailedOperation.CreateTrigger 当前函数状态无法进行此操作。
InternalError.ApiGateway 创建apigw触发器内部错误。
InternalError.Ckafka ckafka接口失败。
InternalError.Cmq 删除cmq触发器失败。
InternalError.Cos 更新触发器失败。
InternalError.System 内部系统错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.ApiGateway ApiGateway参数错误。
InvalidParameterValue.Cdn Cdn传入错误。
InvalidParameterValue.Ckafka Ckafka传入错误。
InvalidParameterValue.Cos Cos传入错误。
InvalidParameterValue.CustomArgument CustomArgument参数长度超限。
InvalidParameterValue.Enable Enable取值与规范不符,请修正后再试。可参考:https://tencentcs.com/5jXKFnBW。
InvalidParameterValue.FunctionName 函数不存在。
InvalidParameterValue.SecretInfo SecretInfo错误。
InvalidParameterValue.ServiceName ServiceName命名不规范。
InvalidParameterValue.TriggerDesc TriggerDesc传入参数错误。
InvalidParameterValue.TriggerName TriggerName传入错误。
InvalidParameterValue.Type Type传入错误。
InvalidParameterValue.ZipFile 检测到不是标准的zip文件,请重新压缩后再试。
LimitExceeded.Cdn Cdn使用超过最大限制。
LimitExceeded.FunctionOnTopic 同一个主题下的函数超过最大限制。
LimitExceeded.Trigger 触发器数量超出最大限制,可通过提交工单申请提升限制。
ResourceInUse 资源被占用。
ResourceInUse.Cdn Cdn已被占用。
ResourceInUse.Cmq Cmq已被占用。
ResourceInUse.Cos Cos已被占用。
ResourceInUse.Trigger TriggerName已存在。
ResourceInUse.TriggerName TriggerName已存在。
ResourceInsufficient.COS COS资源不足。
ResourceNotFound 资源不存在。
ResourceNotFound.Cdn Cdn不存在。
ResourceNotFound.Ckafka Ckafka不存在。
ResourceNotFound.Cmq Cmq不存在。
ResourceNotFound.Cos Cos不存在。
ResourceNotFound.Function 函数不存在。
ResourceNotFound.FunctionName 函数不存在。
ResourceNotFound.FunctionVersion 函数版本不存在。
ResourceNotFound.Namespace Namespace不存在。
ResourceNotFound.Qualifier 版本不存在。
ResourceNotFound.Version 版本不存在。
UnauthorizedOperation.CAM CAM鉴权失败。
UnauthorizedOperation.CreateTrigger 没有权限。
UnsupportedOperation 操作不支持。
UnsupportedOperation.Cdn Cdn不支持。
UnsupportedOperation.Cos Cos操作不支持。
UnsupportedOperation.Trigger Trigger操作不支持。
目录