InvokeFunction - 调用函数

调用执行函数。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
fc:InvokeFunction
  • 全部资源
    *

请求语法

POST /2021-04-06/services/{serviceName}/functions/{functionName}/invocations HTTP/1.1

请求参数

名称类型必填描述示例值
X-Fc-Invocation-Typestring

调用方式。取值说明如下:

  • Sync:同步调用。
  • Async:异步调用。

默认值:同步调用。

Sync
X-Fc-Log-Typestring

请求返回日志。

  • Tail:返回当前请求产生的最后 4 KB 日志。
  • None:默认值,不返回请求日志。
None
serviceNamestring

服务名称。

demoService
qualifierstring

服务的版本 ID 或者别名。

demoQualifier
functionNamestring

函数名称。

demoFunction
bodybyte

事件(event),类型为 binary。函数计算服务将事件传递给用户的函数来处理。

{"key":"value"}
X-Fc-Stateful-Async-Invocation-Idstring

异步任务 ID。您需要事先开启异步任务。

说明 建议您在使用 SDK 调用时设置与业务相关的 ID,方便对相关执行进行后续操作。例如,一个视频处理函数可以使用视频文件名作为调用 ID,通过该 ID 可以查看视频是否处理完成或终止视频的处理。该 ID 的命名规则只能以英文大小写字母或下划线(_)开头,由英文大小写字母、数字(0-9)、下划线(_)及短划线(-)组成,不超过 128 个字符。如果您未设置异步调用的 ID,系统则会自动生成一个 ID。
test-invoke-id
X-Fc-Stateful-Async-Invocation-Enablestring

请求级别异步任务开关。取值说明如下:

  • true:开启本次异步调用为异步任务。
  • false:默认值。
说明 本参数仅面向异步调用,对异步调用生效,同步调用不生效。
true
X-Fc-Account-Idstring

您的阿里云账号(主账号)ID。

188077086902****
X-Fc-Datestring

函数的调用开始日期,格式为EEE,d MMM yyyy HH:mm:ss GMT

Wed, 11 May 2022 09:00:00 GMT
X-Fc-Trace-Idstring

调用函数的 ID,与返回参数 requestId 对应。

test-trace-id

返回参数

名称类型描述示例值
headersobject
X-Fc-Error-Typestring

调用函数的错误类型,分为 HandledInvocationError 和 UnhandledInvocationError 两种。

UnhandledInvocationError
X-Fc-Log-Resultstring

调用函数产生的日志 Tail 结果。

demo log result
X-Fc-Code-Checksumstring

代码校验。

5697641582914695457
X-Fc-Invocation-Durationnumber

本次函数执行的时间,单位为毫秒。

10
X-Fc-Max-Memory-Usagenumber

本次函数执行消耗的最大内存,单位为 MB。

50
byte

请求返回值。

hello world

示例

正常返回示例

JSON格式

"hello world"

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-05-30OpenAPI 入参发生变更查看变更详情
2021-06-29API 内部配置变更,不影响调用查看变更详情
2021-06-29API 内部配置变更,不影响调用查看变更详情