Query stateful asynchronous invocations via ListStatefulAsyncInvocations - Function Compute - Alibaba Cloud -

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.

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:ListStatefulAsyncInvocations

get

*All Resource

*

None

Request syntax

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

Path 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

Request parameters

Parameter	Type	Required	Description	Example
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	integer	No	The start time of the asynchronous task.	1640966400000
startedTimeEnd	integer	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 elements

Element	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.
	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

Success response

JSON format

{
  "nextToken": "8bj81uI8n****",
  "invocations": [
    {
      "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.