All Products
Search
Document Center

Function Compute (2.0):PutFunctionAsyncInvokeConfig

Last Updated:Apr 18, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
serviceNamestringYes

The service name.

demo-service
functionNamestringYes

The function name.

helloworld
qualifierstringNo

The version or alias of the service.

test
bodyobjectNo

The asynchronous invocation configurations.

destinationConfigDestinationConfigNo

The configuration struct of the destination for asynchronous invocations.

maxAsyncEventAgeInSecondslongNo

The maximum validity period of messages. Valid values: [1,2592000]. Unit: seconds.

300
maxAsyncRetryAttemptslongNo

Optional. The maximum number of retries after the asynchronous invocation fails. Valid values: [0,8]. If you do not configure this parameter, the default number of retries is 3.

3
statefulInvocationbooleanNo

Specifies whether to enable the asynchronous task feature.

  • true
  • false
true
X-Fc-Account-IdstringNo

The ID of your Alibaba Cloud account.

188077086902****
X-Fc-DatestringNo

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

The trace ID of the request for the Function Compute API.

ksdfjkdmkki***

Response parameters

ParameterTypeDescriptionExample
object

The asynchronous invocation configurations.

createdTimestring

The time when the alias was created.

2020-09-10T02:45:02Z
destinationConfigDestinationConfig

The configuration struct of the destination for asynchronous invocations.

{"onSuccess": null,"onFailure": {"destination": "acs:mns:cn-shanghai:123:/queues/xxx/messages"}}
functionstring

The function name.

helloworld
lastModifiedTimestring

The time when the configuration was last modified.

2020-09-10T02:45:02Z
maxAsyncEventAgeInSecondslong

The maximum validity period of a message.

300
maxAsyncRetryAttemptslong

The maximum number of retries allowed after an asynchronous invocation fails.

3
qualifierstring

The version or alias of the service.

test
servicestring

The service name.

demo-service
statefulInvocationboolean

Specifies whether to enable the asynchronous task feature.

  • true
  • false
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 timeSummary of changesOperation
2021-06-29The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: X-Fc-Account-Id
    Added Input Parameters: X-Fc-Code-Checksum
    Added Input Parameters: X-Fc-Log-Type
    Added Input Parameters: X-Fc-Invocation-Type
    Added Input Parameters: X-Fc-Date
    Added Input Parameters: X-Fc-Trace-Id
2021-06-29The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: X-Fc-Account-Id
2021-06-29The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    delete Input Parameters: X-Fc-Account-Id