All Products
Search
Document Center

Function Compute:GetFunctionAsyncInvokeConfig

Last Updated:Sep 23, 2024

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.

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:GetFunctionAsyncInvokeConfigget
  • All Resources
    *
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
serviceNamestringYes

The name of the service.

demo-service
functionNamestringYes

The name of the function.

helloworld
qualifierstringNo

The version or alias of the service.

test
X-Fc-Account-IdstringNo

The ID of your Alibaba Cloud account.

188077086902****
X-Fc-DatestringNo

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

The trace ID of the invocation request of Function Compute.

asdf****

Response parameters

ParameterTypeDescriptionExample
object

Asynchronous invocation configurations.

createdTimestring

The time when the desktop group 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 name of the function.

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 name of the service.

demo-service
statefulInvocationboolean

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