Use PutFunctionAsyncInvokeConfig to create or modify an asynchronous invocation configuration - Function Compute - Alibaba Cloud -

Operation description

配置中的 StatefulAsyncInvocation 即为异步任务的配置项。异步任务在普通的异步调用基础上增加了状态管理的功能，更适用于各类任务场景。

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

create

*All Resource

*

None

Request syntax

PUT /2021-04-06/services/{serviceName}/functions/{functionName}/async-invoke-config HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
serviceName	string	Yes	The service name.	demo-service
functionName	string	Yes	The function name.	helloworld

Request parameters

Parameter	Type	Required	Description	Example
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	integer	No	The maximum validity period of a message. Valid values: [1,604800]. Default value: 86400. Unit: seconds.	300
maxAsyncRetryAttempts	integer	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 false	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.	Wed, 11 May 2022 09:00:00 GMT
X-Fc-Trace-Id	string	No	The trace ID of the request for the Function Compute API.	ksdfjkdmkki***

Response elements

Element	Type	Description	Example
	object	The asynchronous invocation configurations.
createdTime	string	The time when the alias was created.	2020-09-10T02:45:02Z
destinationConfig	DestinationConfig	The configuration struct of the destination for asynchronous invocations.	{"onSuccess": null,"onFailure": {"destination": "acs:mns:cn-shanghai:123:/queues/xxx/messages"}}
function	string	The function name.	helloworld
lastModifiedTime	string	The time when the configuration was last modified.	2020-09-10T02:45:02Z
maxAsyncEventAgeInSeconds	integer	The maximum validity period of a message.	300
maxAsyncRetryAttempts	integer	The maximum number of retries allowed after an asynchronous invocation fails.	3
qualifier	string	The version or alias of the service.	test
service	string	The service name.	demo-service
statefulInvocation	boolean	Specifies whether to enable the asynchronous task feature. true false	true

Examples

Success response

JSON format

{
  "createdTime": "2020-09-10T02:45:02Z",
  "destinationConfig": {
    "onSuccess": {
      "destination": "acs:fc:cn-shanghai:xxx:services/s1/functions/f1"
    },
    "onFailure": {
      "destination": "acs:fc:cn-shanghai:xxx:services/s1/functions/f1"
    }
  },
  "function": "helloworld",
  "lastModifiedTime": "2020-09-10T02:45:02Z",
  "maxAsyncEventAgeInSeconds": 300,
  "maxAsyncRetryAttempts": 3,
  "qualifier": "test",
  "service": "demo-service",
  "statefulInvocation": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.