使用ListAsyncTasks获取异步任务列表-函数计算-阿里云-阿里云帮助中心

获取异步任务详情列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
fc:ListAsyncTasks	list	全部资源 ``	无	无

请求语法

GET /2023-03-30/functions/{functionName}/async-tasks HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
functionName	string	是	函数名称。	my-func
prefix	string	否	异步任务 ID 前缀，指定后会返回符合前缀的异步任务列表。	job-
nextToken	string	否	分页标记，用来返回更多结果。第一次查询不需要提供这个参数，后续查询的 Token 从返回结果中获取。	MTIzNCNhYmM=
limit	integer	否	返回异步任务的数量。默认返回 20 个，取值范围[1,100]。	10
qualifier	string	否	函数版本或别名。	LATEST
status	string	否	异步任务执行状态。 Enqueued：异步消息已入队，等待处理。 Dequeued：异步消息已出队，等待触发。 Running：调用执行中。 Succeeded：调用执行成功。 Failed：调用执行失败。 Stopped：调用执行终止。 Stopping：执行停止中。 Expired：您为任务配置了最长排队等待的期限。该任务因为超期被丢弃（任务未被执行）。 Invalid：您的执行因函数被删除等原因处于无效状态（任务未被执行）。 Retrying：异步调用因执行错误重试中。	Running
startedTimeBegin	long	否	异步任务启动时间段的开始时间。	1640966400000
startedTimeEnd	long	否	异步任务启动时间段的结束时间。	1640966400000
sortOrderByTime	string	否	返回异步任务列表的排序方式。 asc 表示升序 desc 表示降序	asc
includePayload	boolean	否	是否返回异步任务的入参。 true：当该参数设置为 true 时，异步任务的列表将返回`invocationPayload`字段。 false：当该参数设置为 false 时，则不返回`invocationPayload`字段。说明 `invocationPayload`字段表示异步任务函数运行时的输入参数。	true

返回参数

名称	类型	描述	示例值
	ListAsyncTaskOutput	返回数据结构体

示例

正常返回示例

JSON格式

{
  "nextToken": "MTIzNCNhYmM=\n",
  "tasks": [
    {
      "alreadyRetriedTimes": 3,
      "destinationStatus": "Succeeded",
      "durationMs": 1000,
      "endTime": 1633449590000,
      "events": [
        {
          "eventDetail": "body",
          "eventId": 1,
          "status": "Succeeded",
          "timestamp": 1647420449721
        }
      ],
      "functionArn": "acs:fc:cn-shanghai:1234/functions/my-func",
      "instanceId": "D4-*******9FD1-882707E",
      "qualifier": "prod",
      "requestId": "e026ae92-61e5-472f-b32d-1c9e3c4e****",
      "returnPayload": "result",
      "startedTime": 1633449590000,
      "status": "Running",
      "taskErrorMessage": "UnhandledInvocationError",
      "taskId": "e026ae92-61e5-472f-b32d-1c9e3c4e****",
      "taskPayload": "body"
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-10-23	API 内部配置变更，不影响调用	查看变更详情