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

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

接口说明

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

fc:ListStatefulAsyncInvocations

get

*全部资源

*

无

请求语法

GET /2021-04-06/services/{serviceName}/functions/{functionName}/stateful-async-invocations HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
serviceName	string	是	异步任务所属服务的名称。	demo-service
functionName	string	是	异步任务所属的函数名称。	demo-function

请求参数

名称	类型	必填	描述	示例值
qualifier	string	否	异步任务所属服务的别名或版本。	LATEST
status	string	否	异步任务的执行状态。 Enqueued：异步消息已入队，等待处理。 Succeeded：调用执行成功。 Failed：调用执行失败。 Running：调用执行中。 Stopped：调用执行终止。 Stopping：执行停止中。 Invalid：您的执行因函数被删除等原因处于无效状态（任务未被执行）。 Expired：您为任务配置了最长排队等待的期限。该任务因为超期被丢弃（任务未被执行）。 Retrying：异步调用因执行错误重试中。	Running
nextToken	string	否	用来返回更多结果。第一次查询不需要提供这个参数，后续查询的 Token 从返回结果中获取。	caeba0****be03f84eb48b699f0a4883
limit	integer	否	异步调用的返回个数。默认返回 20 个，取值范围[1,100]。	20
startedTimeBegin	integer	否	异步任务启动时间段的开始时间。	1640966400000
startedTimeEnd	integer	否	异步任务的结束时间。	1640966400000
sortOrderByTime	string	否	异步调用的排序方式： asc：正序。 desc：逆序。	desc
invocationIdPrefix	string	否	异步调用前缀。限定返回的资源名称，假设`invocationidPrefix`为`job`，则返回的资源名必须以`job`开头。	abcxxx
includePayload	boolean	否	true：当该参数设置为`true`时，异步任务的列表将返回`invocationPayload`字段。 false：当该参数设置为`false`时，则不返回`invocationPayload`字段。说明 `invocationPayload`字段表示异步任务函数运行时的输入参数。	true
X-Fc-Account-Id	string	否	您的阿里云账号（主账号）ID。	188077086902****
X-Fc-Code-Checksum	string	否	函数代码包的 CRC-64 值，用于校验完整性。应当由工具自动计算。	1506052139770049xxxx
X-Fc-Log-Type	string	否	请求返回日志。 Tail：返回当前请求产生的最后 4 KB 日志。 None：默认值，不返回请求日志。	Tail
X-Fc-Invocation-Type	string	否	调用方式。 Sync：同步调用。 Async：异步调用。	Async
X-Fc-Date	string	否	函数的调用开始日期，格式为EEE,d MMM yyyy HH:mm:ss GMT。	Sat, 14 Jul 2017 07:02:38 GMT
X-Fc-Trace-Id	string	否	函数计算调用请求的调用链 ID。	abcxxx

返回参数

名称	类型	描述	示例值
	object	返回数据结构体。
nextToken	string	用来返回更多的查询结果。如果这个值没有返回，则说明没有更多结果。	8bj81uI8n****
invocations	array	异步任务的列表。
	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": "{\"key1\":\"value1\",\"key2\":\"value2\"}",
      "alreadyRetriedTimes": 3,
      "requestId": "ABA740D4-********-882707EADC37",
      "instanceId": "D4-*******9FD1-882707E",
      "events": [
        {
          "eventId": 1,
          "status": "Enqueued",
          "timestamp": 1647420449721,
          "eventDetail": "{\"Error\":\"UnhandledInvocationError\"}"
        }
      ],
      "durationMs": 100,
      "returnPayload": "my-result"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。