All Products
Search
Document Center

Function Compute:ListFunctionAsyncInvokeConfigs

Last Updated:Nov 06, 2024

Queries all asynchronous invocation configurations of a function in a service. If the number of configurations exceeds the value of the limit parameter, the nextToken parameter is returned. You can use the nextToken parameter to query the next page of results.

Operation description

StatefulAsyncInvocation indicates whether the asynchronous task feature is enabled. If StatefulAsyncInvocation is set to true, the asynchronous task is enabled. All asynchronous invocations to the function corresponding to this configuration change to asynchronous task mode.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
serviceNamestringYes

The name of the service.

demo-service
functionNamestringYes

The name of the function.

helloworld
limitintegerNo

The maximum number of resources to return. Default value: 20. The value cannot exceed 100. The number of returned configurations is less than or equal to the specified number.

20
nextTokenstringNo

The token required to obtain more results. If the number of resources exceeds the limit, the nextToken parameter is returned. You can include the parameter in subsequent calls to obtain more results. You do not need to provide this parameter in the first call.

8bj81uI8n****
X-Fc-Account-IdstringNo

The ID of your Alibaba Cloud account.

188077086902****
X-Fc-Code-ChecksumstringNo

The CRC-64 value of the function code package. This value is used to check data integrity. The value is automatically calculated by the tool.

1506052139770049xxxx
X-Fc-Log-TypestringNo

The method used to return logs. Valid values:

  • Tail: returns the last 4 KB of logs that are generated for the current request.
  • None: No logs are returned for the current request. Default value: None.
Tail
X-Fc-Invocation-TypestringNo

The invocation method.

  • Sync: synchronous
  • Async: asynchronous
Async
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

The data struct returned.

configsarray<object>

The list of asynchronous invocation configurations.

configobject

The asynchronous invocation configurations.

createdTimestring

The time when the asynchronous invocation configuration was created.

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

The configuration struct of the destination for asynchronous invocations. If you did not configure this parameter, this parameter is null.

{"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. If you have not configured this parameter, this parameter is null.

300
maxAsyncRetryAttemptslong

The maximum number of retries allowed after an asynchronous invocation fails. If you have not configured this parameter, this parameter is null.

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. Valid values:

  • true
  • false

If you have not configured this parameter, this parameter is null.

true
nextTokenstring

The token used to obtain more results.

caeba0be03****f84eb48b699f0a4883

Examples

Sample success responses

JSONformat

{
  "configs": [
    {
      "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
    }
  ],
  "nextToken": "caeba0be03****f84eb48b699f0a4883"
}

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