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

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

请求头

该接口无特殊请求头,关于公共请求头信息,请参见公共参数

请求语法

GET /services/{serviceName[.qualifier]}/functions/{functionName}/stateful-async-invocations HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
serviceName String Path service_name

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

functionName String Path function_name

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

qualifier String Path alias

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

invocationIdPrefix String Path job-***

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

nextToken String Query e026ae92-61e5-472f-b32d-1c9e3c4e****

异步任务的查询起始过滤字段。第一次查询不需要提供这个参数,后续查询的Token从返回结果中获取。

limit Integer Query 50

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

startedTimeBegin Long Query 161941846****

异步任务启动时间及起始值的过滤字段。单位:毫秒。

startedTimeEnd Long Query 161941846****

异步任务启动时间及结束值的过滤字段。单位:毫秒。

sortOrderByTime String Query asc

异步调用的排序方式。

  • asc:正序。
  • desc:逆序。
includePayload Boolean Query true
  • true:当该参数设置为true时,异步任务的列表将返回invocationPayload字段。
  • false:当该参数设置为false时,则不返回invocationPayload字段。
说明 invocationPayload字段表示异步任务函数运行时的输入参数。

返回数据

名称 类型 示例值 描述
invocations Array

异步任务的列表。

startedTime Long 2020-08-20T02:28:21Z

异步任务的开始时间。

endTime Long 2020-08-20T02:38:21Z

异步任务的结束时间。

functionName String function_name

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

qualifier String alias

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

serviceName String service_name

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

invocationId String e026ae92-61e5-472f-b32d-1c9e3c4e****

异步任务ID。

requestId String 403fcbd6-ec41-401f-9fa7-386f3d3d****

异步任务的请求ID。

status String Succeeded

异步任务的执行状态。

  • Enqueued:异步消息已入队,等待处理。
  • Dequeued:异步消息已出队,等待触发。
  • Running:调用执行中。
  • Succeeded:调用执行成功。
  • Failed:调用执行失败。
  • Stopped:调用执行终止。
  • Stopping:执行停止中。
  • Expired:您给异步消息配置了存活有效期,该消息因过期已被丢弃(未触发)。
  • Invalid:您的执行因函数被删除等原因处于无效状态(未触发)。
  • Retrying:异步调用因执行错误重试中。
destinationStatus String Succeeded

异步任务的目的状态。

invocationErrorMessage String UnhandledInvocationError

异步任务的错误消息。

InvocationPayload String hello world

异步任务的任务触发事件。

alreadyRetriedTimes Long 3

异步任务调用失败后的最大重试次数,默认值为3。取值范围[0,8]。

nextToken String caeba0be03****f84eb48b699f0a4883

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

示例

请求示例

GET /services/{serviceName[.qualifier]}/functions/function_name/stateful-async-invocations?nextToken=e026ae92-61e5-472f-b32d-1c9e3c4e****&limit=50&sortOrderByTime=asc&includePayload=true HTTP/1.1
Host:fc-ram.aliyuncs.com
Content-Type:application/json
公共请求头

正常返回示例

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "invocations" : [ {
    "functionName" : "function_name",
    "qualifier" : "alias",
    "serviceName" : "service_name",
    "invocationId" : "e026ae92-61e5-472f-b32d-1c9e3c4e****",
    "requestId" : "403fcbd6-ec41-401f-9fa7-386f3d3d****",
    "status" : "Succeeded",
    "destinationStatus" : "Succeeded",
    "invocationErrorMessage" : "UnhandledInvocationError",
    "InvocationPayload" : "hello world",
    "alreadyRetriedTimes" : 3
  } ],
  "nextToken" : "caeba0be03****f84eb48b699f0a4883"
}