GetFunctionAsyncInvokeConfig - Function Compute - Alibaba Cloud Documentation Center

Obtains asynchronous invocation configurations of a function.

Operation description

StatefulAsyncInvocation indicates whether the asynchronous task feature is enabled. If the value of StatefulAsyncInvocation is true, the asynchronous task feature is enabled. All asynchronous invocations change to asynchronous task mode.

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:GetFunctionAsyncInvokeConfig	get	All Resources *	none	none

Request syntax

GET /2021-04-06/services/{serviceName}/functions/{functionName}/async-invoke-config

Request parameters

Parameter	Type	Required	Description	Example
serviceName	string	Yes	The name of the service.	demo-service
functionName	string	Yes	The name of the function.	helloworld
qualifier	string	No	The version or alias of the service.	test
X-Fc-Account-Id	string	No	The ID of your Alibaba Cloud account.	188077086902****
X-Fc-Date	string	No	The time when the Function Compute is called. The format is EEE,d MMM yyyy HH:mm:ss GMT.	Sat, 14 Jul 2017 07:02:38 GMT
X-Fc-Trace-Id	string	No	The trace ID of the invocation request of Function Compute.	asdf****

Response parameters

Parameter	Type	Description	Example
	object	Asynchronous invocation configurations.
createdTime	string	The time when the desktop group 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 name of the function.	helloworld
lastModifiedTime	string	The time when the configuration was last modified.	2020-09-10T02:45:02Z
maxAsyncEventAgeInSeconds	long	The maximum validity period of a message.	300
maxAsyncRetryAttempts	long	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 name of the service.	demo-service
statefulInvocation	boolean	Indicates whether the asynchronous task feature is enabled. true: The asynchronous task feature is enabled. false: The asynchronous task feature is disabled.	true

Examples

Sample success responses

JSONformat

{
  "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

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