PutFunctionAsyncInvokeConfig - 配置函数异步请求配置

创建或更新函数的异步调用配置。

接口说明

配置中的 StatefulAsyncInvocation 即为异步任务的配置项。异步任务在普通的异步调用基础上增加了状态管理的功能,更适用于各类任务场景。

调试

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

授权信息

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

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

请求语法

PUT /2021-04-06/services/{serviceName}/functions/{functionName}/async-invoke-config HTTP/1.1

请求参数

名称类型必填描述示例值
serviceNamestring

服务名称。

demo-service
functionNamestring

函数名称。

helloworld
qualifierstring

服务的版本或别名。

test
bodyobject

异步调用配置。

destinationConfigDestinationConfig

异步调用目标的配置结构体。

maxAsyncEventAgeInSecondslong

消息最大存活时长,取值范围[1,604800],默认为 86400,单位为秒。

300
maxAsyncRetryAttemptslong

异步调用失败后的最大重试次数,非必填。取值范围[0,8]。当您未进行配置时,系统内部默认重试次数为 3。

3
statefulInvocationboolean

是否开启异步任务。

  • 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。

ksdfjkdmkki***

返回参数

名称类型描述示例值
object

异步调用配置。

createdTimestring

创建时间。

2020-09-10T02:45:02Z
destinationConfigDestinationConfig

异步调用目标的配置结构体。

{"onSuccess": null,"onFailure": {"destination": "acs:mns:cn-shanghai:123:/queues/xxx/messages"}}
functionstring

函数名称。

helloworld
lastModifiedTimestring

最后更改时间。

2020-09-10T02:45:02Z
maxAsyncEventAgeInSecondslong

消息最大存活时长。

300
maxAsyncRetryAttemptslong

异步调用失败后的最大重试次数。

3
qualifierstring

服务的版本或别名。

test
servicestring

服务名称。

demo-service
statefulInvocationboolean

是否开启异步任务。

  • true:表示已开启异步任务。
  • false:表示未开启异步任务。
true

示例

正常返回示例

JSON格式

{
  "createdTime": "2020-09-10T02:45:02Z",
  "destinationConfig": {
    "onSuccess": {
      "destination": "acs:fc:cn-shanghai:xxx:services/s1/functions/f1"
    },
    "onFailure": {
      "destination": "acs:fc:cn-shanghai:xxx:services/s1/functions/f1"
    }
  },
  "function": "helloworld",
  "lastModifiedTime": "2020-09-10T02:45:02Z",
  "maxAsyncEventAgeInSeconds": 300,
  "maxAsyncRetryAttempts": 3,
  "qualifier": "test",
  "service": "demo-service",
  "statefulInvocation": true
}

错误码

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

变更历史

变更时间变更内容概要操作
2021-06-29OpenAPI 入参发生变更查看变更详情
2021-06-29OpenAPI 入参发生变更查看变更详情
2021-06-29OpenAPI 入参发生变更查看变更详情