All Products
Search
Document Center

Function Compute:ListFunctionAsyncInvokeConfigs

Last Updated:May 14, 2024

Lists the 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 this parameter to query the next page of results.

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.

Request headers

This operation uses only common request headers. For more information, see Common parameters.

Request syntax

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

Request parameters

Parameter

Type

Position

Required

Example

Description

serviceName

String

Path

Yes

service_name

The name of the service that contains the function for which you want to query the asynchronous invocation configurations.

functionName

String

Path

Yes

testHelloWorld

The name of the function for which you want to query the asynchronous invocation configurations.

limit

Integer

Query

No

20

The maximum number of asynchronous invocation configurations to return. Default value: 20. Maximum value: 100. The number of returned configurations is less than or equal to the specified number.

nextToken

String

Query

No

caeba0be03****f84eb48b699f0a4883

The token used to obtain more results. You do not need to specify this parameter in the first query. If the number of results exceeds the limit, the nextToken parameter is returned, the value of which can be used in subsequent calls to obtain more results.

Response parameters

Parameter

Type

Example

Description

configs

Array

The configurations.

createdTime

String

2020-08-20T02:28:21Z

The time when the asynchronous invocation configuration was created.

destinationConfig

DestinationConfig

The configuration structure of the destination for asynchronous invocations.

functionName

String

testHelloWorld

The name of the function to which the asynchronous invocation configuration belongs.

lastModifiedTime

String

2020-09-10T02:45:02Z

The time when the asynchronous invocation configuration was last modified.

maxAsyncEventAgeInSeconds

Long

1

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

maxAsyncRetryAttempts

Long

1

The maximum number of retries that are allowed after an asynchronous invocation fails. Default value: 3. Valid values: [0,8].

qualifier

String

alias

The alias or version of the service that contains the function to which the asynchronous invocation configuration belongs.

serviceName

String

service_name

The name of the service that contains the function to which the asynchronous invocation configuration belongs.

statefulInvocation

Boolean

true

Indicates whether the asynchronous task feature is enabled.

  • true: The asynchronous task feature is enabled.

  • false: The asynchronous task feature is disabled.

nextToken

String

caeba0be03****f84eb48b699f0a4883

The token used to obtain more results. If the number of asynchronous invocation configurations exceeds the limit, the nextToken parameter is returned. You must include this parameter in subsequent calls to obtain more results. You do not need to specify this parameter in the first call.

Examples

Sample requests

GET /2016-08-15/services/service_name.alias/functions/testHellowWorld/async-invoke-configs?NextToken=caeba0be03*******b699f0a4883&Limit=20 HTTP/1.1
Common request header

Sample success responses

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "configs" : [ {
    "createdTime" : "2020-08-20T02:28:21Z",
    "destinationConfig" : {
      "onFailure" : {
        "destination" : "acs:mns:cn-shanghai:1986***743:/queues/failure/messages"
      },
      "onSuccess" : {
        "destination" : "acs:mns:cn-shanghai:1986***743:/queues/success/messages"
      }
    },
    "functionName" : "testHelloWorld",
    "lastModifiedTime" : "2020-09-10T02:45:02Z",
    "maxAsyncEventAgeInSeconds" : 1,
    "maxAsyncRetryAttempts" : 1,
    "qualifier" : "alias",
    "serviceName" : "service_name",
    "statefulInvocation" : true
  } ],
  "nextToken" : "caeba0be03****f84eb48b699f0a4883"
}