ListStatefulAsyncInvocations - Function Compute - Alibaba Cloud Documentation Center

Queries all asynchronous invocations in an asynchronous task that meets specific conditions.

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
fc:ListStatefulAsyncInvocations	get	All Resources *	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
serviceName	string	Yes	The name of the service to which the asynchronous task belongs.	demo-service
functionName	string	Yes	The name of the function to which the asynchronous task belongs.	demo-function
qualifier	string	No	The version or alias of the service to which the asynchronous task belongs.	LATEST
status	string	No	The state of the asynchronous task. Enqueued: The asynchronous task is enqueued and is waiting to be executed. Succeeded: The invocation succeeded. Failed: The invocation failed. Running: The invocation is being executed. Stopped: The invocation was terminated. Stopping: The invocation is being terminated. Invalid: The invocation is invalid and not executed due to specific reasons. For example, the function is deleted. Expired: The maximum validity period of messages is specified for the asynchronous invocation. The invocation is discarded and not executed because the specified maximum validity period of messages elapsed. Retrying: The asynchronous task is being retried due to an execution error.	Running
nextToken	string	No	The token required to obtain more results. You do not need to specify this parameter in the first call. If a NextToken value is returned by a previous call, more results are available.	caeba0****be03f84eb48b699f0a4883
limit	integer	No	The maximum number of asynchronous tasks to be returned. The default value is 20. Valid values: [1,100].	20
startedTimeBegin	long	No	The start time of the asynchronous task.	1640966400000
startedTimeEnd	long	No	The end time of the asynchronous task.	1640966400000
sortOrderByTime	string	No	The method that you want to use to sort the returned asynchronous tasks. asc: the ascending order desc: the descending order	desc
invocationIdPrefix	string	No	The name prefix of the asynchronous tasks. This parameter is used to limit the names of the returned asynchronous tasks. For example, if you set the `invocationidPrefix` parameter to `job`, the names of the returned invocations must start with `job`.	abcxxx
includePayload	boolean	No	Specifies whether to return the invocationPayload parameter in the response. true: returns the `invocationPayload` parameter in the response.`` false: does not return the `invocationPayload` parameter in the response.`` Note The `invocationPayload` parameter indicates the input parameters of an asynchronous task.	true
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 the tool.	1506052139770049xxxx
X-Fc-Log-Type	string	No	The method used to return logs. Tail: returns the last 4 KB of logs that are generated for the current request. None: does not return logs for the current request. Default value: None.	Tail
X-Fc-Invocation-Type	string	No	The method used to invoke the function. Sync: synchronous invocations Async: asynchronous invocations	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.	abcxxx

Response parameters

Parameter	Type	Description	Example
	object	The data struct returned.
nextToken	string	The token used to obtain more results. If this parameter is left empty, all the results are returned.	8bj81uI8n****
invocations	array	The list of asynchronous tasks.
invocation	StatefulAsyncInvocation	The information about the asynchronous task.	[{"functionName": "demo-function","serviceName": "demo-service","qualifier": "LATEST","invocationId": "id","status": "Succeeded","startedTime": 1640966400000,"endTime": 1640966500000,"destinationStatus": "Succeeded","invocationErrorMessage": "","invocationPayload": "","requestId": "id","alreadyRetriedTimes": 0,}]

Examples

Sample success responses

JSONformat

{
  "nextToken": "8bj81uI8n****",
  "invocations": [
    {
      "functionName": "functionName",
      "serviceName": "serviceName",
      "qualifier": "LATEST",
      "invocationId": "cxxdfd",
      "status": "Running",
      "startedTime": 1633449590,
      "endTime": 1633449599,
      "destinationStatus": "Succeeded",
      "invocationErrorMessage": "UnhandledInvocationError",
      "invocationPayload": "\"body\"",
      "alreadyRetriedTimes": 3,
      "requestId": "ABA740D4-4BA6-5293-9FD1-882707EADC37",
      "instanceId": "D4-4BA6-5293-9FD1-882707E",
      "events": [
        {
          "eventId": 1,
          "status": "Enqueued",
          "timestamp": 1647420449721,
          "eventDetail": "{\"Error\":\"UnhandledInvocationError\"}"
        }
      ],
      "durationMs": 100,
      "returnPayload": "my-result"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2021-06-30	The request parameters of the API has changed	View Change Details
2021-06-30	The request parameters of the API has changed	View Change Details
2021-06-30	The request parameters of the API has changed	View Change Details