文档

ListAsyncTasks - 获取异步任务列表

更新时间:
一键部署

获取异步任务详情列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

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

请求参数

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

函数名称。

my-func
prefixstring

异步任务 ID 前缀,指定后会返回符合前缀的异步任务列表。

job-
nextTokenstring

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

MTIzNCNhYmM=
limitinteger

返回异步任务的数量。默认返回 50 个,取值范围[1,100]。

10
qualifierstring

函数版本或别名。

LATEST
statusstring

异步任务执行状态。

  • Enqueued:异步消息已入队,等待处理。

  • Succeeded:调用执行成功。

  • Failed:调用执行失败。

  • Running:调用执行中。

  • Stopped:调用执行终止。

  • Stopping:执行停止中。

  • Invalid:您的执行因函数被删除等原因处于无效状态(任务未被执行)。

  • Expired:您为任务配置了最长排队等待的期限。该任务因为超期被丢弃(任务未被执行)。

  • Retrying:异步调用因执行错误重试中。

Running
startedTimeBeginlong

异步任务启动时间段的开始时间。

1640966400000
startedTimeEndlong

异步任务启动时间段的结束时间。

1640966400000
sortOrderByTimestring

返回异步任务列表的排序方式。

  • asc 表示升序

  • desc 表示降序

asc
includePayloadboolean

是否返回异步任务的入参。

  • 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"
    }
  ]
}

错误码

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

  • 本页导读 (1)