最佳实践

运行函数

最近更新时间:2021-09-02 08:06:58

我的收藏

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 公共参数,本接口取值:Invoke。
Version String 公共参数,本接口取值:2018-04-16。
Region String 公共参数,详见产品支持的 地域列表
FunctionName String 函数名称
InvocationType String 同步调用请使用同步 Invoke 调用接口 或填写同步调用参数 RequestResponse ,建议使用同步调用接口以获取最佳性能;异步调用填写 Event;默认为同步。接口超时时间为 300s,更长超时时间请使用异步调用。
Qualifier String 触发函数的版本号或别名
ClientContext String 运行函数时的参数,以json格式传入,同步调用最大支持 6MB,异步调用最大支持 128 KB。该字段信息对应函数 event 入参
LogType String 异步调用该字段返回为空。
Namespace String 命名空间
RoutingKey String 函数灰度流量控制调用,以json格式传入,例如{"k":"v"},注意kv都需要是字符串类型,最大支持的参数长度是1024字节

3. 输出参数

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

4. 示例

示例1 运行函数

输入示例

https://scf.tencentcloudapi.com/?Action=Invoke
&FunctionName=xxxx
&<公共请求参数>

输出示例

{
  "Response": {
    "Result": {
      "MemUsage": 3207168,
      "Log": "",
      "RetMsg": "hello from scf",
      "BillDuration": 100,
      "FunctionRequestId": "6add56fa-58f1-11e8-89a9-5254005d5fdb",
      "Duration": 0.826,
      "ErrMsg": "",
      "InvokeResult": 0
    },
    "RequestId": "c2af8a64-c922-4d55-aee0-bd86a5c2cd12"
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.FunctionStatusError 函数在部署中,无法做此操作。
FailedOperation.InvokeFunction 调用函数失败。
InternalError 内部错误。
InternalError.System 内部系统错误。
InvalidParameter.FunctionName FunctionName取值与规范不符,请修正后再试。可参考:https://tencentcs.com/5jXKFnBW。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.Param 入参不是标准的json。
ResourceNotFound.Function 函数不存在。
ResourceNotFound.FunctionName 函数不存在。
ResourceUnavailable.InsufficientBalance 余额不足,请先充值。
UnauthorizedOperation.CAM CAM鉴权失败。
目录