全部产品
Search

搜索本产品

    函数计算：GetStatefulAsyncInvocation - 获取异步任务信息

    文档中心

    函数计算：GetStatefulAsyncInvocation - 获取异步任务信息

    更新时间：Sep 23, 2024

    获取符合条件的异步任务记录。

    接口说明

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

    调试

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

    授权信息

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

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

    请求语法

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

    请求参数

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

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

    		demo-service
    functionNamestring是

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

    		demo-function
    invocationIdstring是

    异步任务的 ID。

    说明 建议您在使用 SDK 调用时设置与业务相关的 ID，方便对相关执行进行后续操作。例如，一个视频处理函数可以使用视频文件名作为调用 ID，通过该 ID 可以查看视频是否处理完成或终止视频的处理。该 ID 的命名规则只能以英文大小写字母或下划线（_）开头，由英文大小写字母、数字（0-9）、下划线（_）及短划线（-）组成，不超过 128 个字符。如果您未设置异步调用的 ID 时，系统则会自动生成一个 ID。
    		e026ae92-61e5-472f-b32d-1c9e3c4e****
    qualifierstring否

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

    		LATEST
    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。

    		asdf****

    返回参数

    名称类型描述示例值
    StatefulAsyncInvocation

    异步任务调用数据。 该参数下的 returnPayload 字段当前处于内测阶段，如您需要使用，请联系我们为您开通。

    		 [{"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格式

    {
  "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"
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2021-06-30OpenAPI 入参发生变更查看变更详情
    2021-06-30OpenAPI 入参发生变更查看变更详情
    2021-06-30OpenAPI 入参发生变更查看变更详情