首页 函数计算 API与工具 API参考(2021-04-16推荐) API目录 异步任务 ListStatefulAsyncInvocations - 获取异步任务信息列表

ListStatefulAsyncInvocations - 获取异步任务信息列表

获取异步任务重符合某些条件的所有异步调用。

接口说明

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

调试

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

调试

授权信息

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

请求参数

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

异步任务所属服务的名称。

demo-service
functionNamestring

异步任务所属的函数名称。

demo-function
qualifierstring

异步任务所属服务的别名或版本。

LATEST
statusstring

异步任务的执行状态。

  • Enqueued:异步消息已入队,等待处理。
  • Succeeded:调用执行成功。
  • Failed:调用执行失败。
  • Running:调用执行中。
  • Stopped:调用执行终止。
  • Stopping:执行停止中。
  • Invalid:您的执行因函数被删除等原因处于无效状态(任务未被执行)。
  • Expired:您为任务配置了最长排队等待的期限。该任务因为超期被丢弃(任务未被执行)。
  • Retrying:异步调用因执行错误重试中。
Running
nextTokenstring

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

caeba0****be03f84eb48b699f0a4883
limitinteger

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

20
startedTimeBeginlong

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

1640966400000
startedTimeEndlong

异步任务的结束时间。

1640966400000
sortOrderByTimestring

异步调用的排序方式:

  • asc:正序。
  • desc:逆序。
desc
invocationIdPrefixstring

异步调用前缀。限定返回的资源名称,假设invocationidPrefixjob,则返回的资源名必须以job开头。

abcxxx
includePayloadboolean
  • true:当该参数设置为true时,异步任务的列表将返回invocationPayload字段。
  • false:当该参数设置为false时,则不返回invocationPayload字段。
说明invocationPayload字段表示异步任务函数运行时的输入参数。
true
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。

abcxxx

返回参数

名称类型描述示例值
object

返回数据结构体。

nextTokenstring

用来返回更多的查询结果。如果这个值没有返回,则说明没有更多结果。

8bj81uI8n****
invocationsarray

异步任务的列表。

StatefulAsyncInvocation

异步任务的列表元素。

[{"functionName": "demo-function","serviceName": "demo-service","qualifier": "LATEST","invocationId": "id","status": "Succeeded","startedTime": 1640966400000,"endTime": 1640966500000,"destinationStatus": "Succeeded","invocationErrorMessage": "","invocationPayload": "","requestId": "id","alreadyRetriedTimes": 0,}]

示例

正常返回示例

JSON格式

{
  "nextToken": "8bj81uI8n****",
  "invocations": [
    {
      "functionName": "functionName",
      "serviceName": "serviceName",
      "qualifier": "LATEST",
      "invocationId": "demo-id",
      "status": "Running",
      "startedTime": 1633449590000,
      "endTime": 1633449599000,
      "destinationStatus": "Succeeded",
      "invocationErrorMessage": "UnhandledInvocationError",
      "invocationPayload": "\"body\"",
      "alreadyRetriedTimes": 3,
      "requestId": "ABA740D4-********-882707EADC37",
      "instanceId": "D4-*******9FD1-882707E",
      "events": [
        {
          "eventId": 1,
          "status": "Enqueued",
          "timestamp": 1647420449721,
          "eventDetail": "{\"Error\":\"UnhandledInvocationError\"}"
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2021-06-30OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:X-Fc-Account-Id
    新增入参:X-Fc-Code-Checksum
    新增入参:X-Fc-Log-Type
    新增入参:X-Fc-Invocation-Type
    新增入参:X-Fc-Date
    新增入参:X-Fc-Trace-Id
2021-06-30OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:X-Fc-Account-Id
2021-06-30OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    删除入参:X-Fc-Account-Id
阿里云首页 函数计算 相关技术圈