All Products
Search
Document Center

Function Compute:GetStatefulAsyncInvocation

Last Updated:Oct 10, 2024

Gets asynchronous task records that meet specified 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
fc:GetStatefulAsyncInvocationget
  • All Resources
    *
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
serviceNamestringYes

The name of service to which the asynchronous tasks belong.

demo-service
functionNamestringYes

The name of function to which the asynchronous task belongs.

demo-function
invocationIdstringYes

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****
qualifierstringNo

The version or alias of the service to which the asynchronous task belongs.

LATEST
X-Fc-Account-IdstringNo

The ID of your Alibaba Cloud account.

188077086902****
X-Fc-Code-ChecksumstringNo

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-TypestringNo

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-TypestringNo

The method used to invoke the function. Valid values:

  • Sync: synchronous invocation mode
  • Async: asynchronous invocation mode
Async
X-Fc-DatestringNo

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-IdstringNo

The trace ID of the request for Function Compute API.

asdf****

Response parameters

ParameterTypeDescriptionExample
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

Sample success responses

JSONformat

{
  "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 timeSummary of changesOperation
2021-06-30The request parameters of the API has changedView Change Details
2021-06-30The request parameters of the API has changedView Change Details
2021-06-30The request parameters of the API has changedView Change Details