Creates or modifies an asynchronous invocation configuration for a function.
Operation description
StatefulAsyncInvocation specifies the configurations of an asynchronous task. Asynchronous tasks (StatefulAsyncInvocation) allow you to manage the states of asynchronous invocations. The asynchronous task feature is more suitable for task scenarios.
Debugging
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 Resourcesis 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:PutFunctionAsyncInvokeConfig | create |
|
| none |
Request syntax
PUT /2021-04-06/services/{serviceName}/functions/{functionName}/async-invoke-config HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| serviceName | string | Yes | The service name. | demo-service |
| functionName | string | Yes | The function name. | helloworld |
| qualifier | string | No | The version or alias of the service. | test |
| body | object | No | The asynchronous invocation configurations. | |
| destinationConfig | DestinationConfig | No | The configuration struct of the destination for asynchronous invocations. | |
| maxAsyncEventAgeInSeconds | long | No | The maximum validity period of a message. Valid values: [1,604800]. Default value: 86400. Unit: seconds. | 300 |
| maxAsyncRetryAttempts | long | No | Optional. The maximum number of retries if an asynchronous invocation fails. Valid values: [0,8]. If you do not configure this parameter, the default number of retries is 3. | 3 |
| statefulInvocation | boolean | No | Specifies whether to enable the asynchronous task feature.
| true |
| X-Fc-Account-Id | string | No | The ID of your Alibaba Cloud account. | 188077086902**** |
| 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. | The information about the asynchronous invocation configuration. |
| X-Fc-Trace-Id | string | No | The trace ID of the request for the Function Compute API. | ksdfjkdmkki*** |
Response parameters
Examples
Sample success responses
JSONformat
{
"createdTime": "2020-09-10T02:45:02Z",
"destinationConfig": {
"onSuccess": {
"destination": ""
},
"onFailure": {
"destination": ""
}
},
"function": "helloworld",
"lastModifiedTime": "2020-09-10T02:45:02Z",
"maxAsyncEventAgeInSeconds": 300,
"maxAsyncRetryAttempts": 3,
"qualifier": "test",
"service": "demo-service",
"statefulInvocation": true
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2021-06-29 | The request parameters of the API has changed | View Change Details |
| 2021-06-29 | The request parameters of the API has changed | View Change Details |
| 2021-06-29 | The request parameters of the API has changed | View Change Details |