全部产品
Search

搜索本产品

    函数计算：ListFunctionAsyncInvokeConfigs - 获取函数异步配置列表

    文档中心

    函数计算：ListFunctionAsyncInvokeConfigs - 获取函数异步配置列表

    更新时间：Sep 23, 2024

    查询一个服务下某个函数的所有异步配置。当配置个数超过limit个数时，将返回nexttoken参数。可以使用该参数进行后续的分页查询。

    接口说明

    配置中的 StatefulAsyncInvocation 即为异步任务的配置项。当 StatefulAsyncInvocation 取值为 true 时，代表您已开启异步任务。该配置所对应应函数的所有的异步调用将变为异步任务模式。

    调试

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

    授权信息

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

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

    请求语法

    GET /2021-04-06/services/{serviceName}/functions/{functionName}/async-invoke-configs HTTP/1.1

    请求参数

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

    服务名称。

    		demo-service
    functionNamestring是

    函数名称。

    		helloworld
    limitinteger否

    最多返回个数。 如果不设定，默认返回 20，最大不能超过 100。返回结果可以小于指定的数量，但不会多于指定的数量。

    		20
    nextTokenstring否

    用来返回更多结果。第一次查询不需要提供这个参数，后续查询的 Token 从返回结果中获取。

    		8bj81uI8n****
    X-Fc-Account-Idstring否

    您的阿里云账号（主账号）ID。

    		188077086902****
    X-Fc-Code-Checksumstring否

    函数代码包的 CRC-64 值，用于校验完整性。应当由工具自动计算。

    		1506052139770049xxxx
    X-Fc-Log-Typestring否

    请求返回日志。

    • Tail：返回当前请求产生的最后 4 KB 日志。
    • None：默认值，不返回请求日志。
    		Tail
    X-Fc-Invocation-Typestring否

    调用方式。

    • Sync：同步调用。
    • Async：异步调用。
    		Async
    X-Fc-Datestring否

    函数计算调用时间，格式为EEE,d MMM yyyy HH:mm:ss GMT。

    		Sat, 14 Jul 2017 07:02:38 GMT
    X-Fc-Trace-Idstring否

    函数计算调用请求的调用链 ID。

    		asdf****

    返回参数

    名称类型描述示例值
    object

    查询异步配置结果结构体。

    configsarray<object>

    异步配置列表。

    configobject

    异步调用配置。

    createdTimestring

    创建时间。

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

    异步调用目标的配置结构体。如果您未进行配置，则该项为空值（Null）。

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

    函数名称。

    		helloworld
    lastModifiedTimestring

    最后更改时间。

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

    消息最大存活时长。如果您未进行配置，则该项为空值（Null）。

    		300
    maxAsyncRetryAttemptslong

    异步调用失败后的最大重试次数。如果您未进行配置，则该项为空值（Null）。

    		3
    qualifierstring

    服务所属版本或别名。

    		test
    servicestring

    服务名称。

    		demo-service
    statefulInvocationboolean

    是否开启异步任务。

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

    如果您未进行配置，则该项为空值（Null）。

    		true
    nextTokenstring

    下次查询 Token。

    		caeba0be03****f84eb48b699f0a4883

    示例

    正常返回示例

    JSON格式

    {
  "configs": [
    {
      "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
    }
  ],
  "nextToken": "caeba0be03****f84eb48b699f0a4883"
}

    错误码

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

    变更历史

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