Get asynchronous task records by using GetStatefulAsyncInvocation - Function Compute - Alibaba Cloud -

Operation description

StatefulAsyncInvocation represents asynchronous tasks. Asynchronous tasks (StatefulAsyncInvocation) allow you to manage the states of asynchronous invocations. The asynchronous task feature is more suitable for task scenarios.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

fc:GetStatefulAsyncInvocation

get

*All Resource

*

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
serviceName	string	Yes	The name of service to which the asynchronous tasks belong.	demo-service
functionName	string	Yes	The name of function to which the asynchronous task belongs.	demo-function
invocationId	string	Yes	The ID of the asynchronous task. Note If you use an SDK to invoke a function, we recommend that you specify a business-related ID to facilitate subsequent operations. For example, a video processing function can use video file names as invocation IDs. This way, you can easily check whether a video is successfully processed or terminated before it is processed. The ID must start with a letter or an underscore (_) and can contain letters, digits (0-9), underscores (_), and hyphens (-). The ID can be up to 128 characters in length. If you do not specify the ID of an asynchronous invocation, Function Compute automatically generates an ID.	e026ae92-61e5-472f-b32d-1c9e3c4e****

Request parameters

Parameter	Type	Required	Description	Example
qualifier	string	No	The version or alias of the service to which the asynchronous task belongs.	LATEST
X-Fc-Account-Id	string	No	The ID of your Alibaba Cloud account.	188077086902****
X-Fc-Code-Checksum	string	No	The CRC-64 value of the function code package. This value is used to check data integrity. The value is automatically calculated by a tool.	1506052139770049xxxx
X-Fc-Log-Type	string	No	The method used to return logs. Default value: None. Valid values: Tail: returns the last 4 KB of logs that are generated for the current request. None: does not return logs for the request.	Tail
X-Fc-Invocation-Type	string	No	The method used to invoke the function. Valid values: Sync: synchronous invocation mode Async: asynchronous invocation mode	Async
X-Fc-Date	string	No	The time when the function is invoked. The value is in the EEE,d MMM yyyy HH:mm:ss GMT format.	Sat, 14 Jul 2017 07:02:38 GMT
X-Fc-Trace-Id	string	No	The trace ID of the request for Function Compute API.	asdf****

Response elements

Element	Type	Description	Example
	StatefulAsyncInvocation	The information about the asynchronous task. The returnPayload parameter is in beta test. If you want to use this parameter, contact us.	Alibaba Cloud CLI

Examples

Success response

JSON format

{
  "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\"}"
    }
  ],
  "durationMs": 100,
  "returnPayload": "my-result"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.