Help Center> FunctionGraph> API Reference> Function Management Zone API> Obtaining the Asynchronous Invocation Configurations of All Versions of a Function
View PDF

Obtaining the Asynchronous Invocation Configurations of All Versions of a Function

Function

This API is used to obtain the asynchronous invocation configurations of all versions of a function.

URI

GET /v2/{project_id}/fgs/functions/{function_urn}/async-invoke-configs

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant's project ID.

Minimum: 1

Maximum: 32

function_urn

Yes

String

Function URN.

Minimum: 1

Maximum: 269
Table 2 Query parameters

Parameter

Mandatory

Type

Description

marker

No

String

Final record queried last time.

Default: 0

Minimum: 1

Maximum: 64

limit

No

String

Number of records displayed per page.

  • If this parameter is not provided or is set to 0, the default value 10 will be used. The maximum value is 100. If you set this parameter to a value greater than 100, the system will automatically change it to 100.

  • If this parameter is less than 0, a message indicating a parameter error will be returned.

Default: 10

Minimum: 1

Maximum: 64

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

async_invoke_configs

Array of FunctionAsyncInvokeConfigResp objects

Asynchronous invocation configuration list.

count

Long

Total number of asynchronous invocation configurations in the list.

Minimum: 0

page_info

PageInfo object

Asynchronous invocation target.
Table 4 FunctionAsyncInvokeConfigResp

Parameter

Type

Description

func_urn

String

Function URN.

Minimum: 1

Maximum: 269

max_async_event_age_in_seconds

Integer

Maximum validity period of a message. Value range: 60s to 86,400s.

max_async_retry_attempts

Integer

Maximum number of retry attempts to be made if an asynchronous invocation failure occurs. Default value: 3. Value range: 0–8.

destination_config

FuncAsyncDestinationConfig object

Asynchronous invocation target.

created_time

String

Time when the asynchronous invocation configuration was created.

last_modified

String

Time when the asynchronous invocation configuration was modified.
Table 5 FuncAsyncDestinationConfig

Parameter

Type

Description

on_success

FuncDestinationConfig object

Target to be invoked when a function is successfully executed.

on_failure

FuncDestinationConfig object

Target to be invoked when a function fails to be executed due to a system error or an internal error.
Table 6 FuncDestinationConfig

Parameter

Type

Description

destination

String

Target service type.

  • OBS: Notifications are sent to the OBS service.

  • SMN: Notifications are sent to the SMN service.

  • DIS: Notifications are sent to the DIS service.

  • FunctionGraph: Notifications are sent to FunctionGraph.

Enumeration values:

  • OBS

  • SMN

  • DIS

  • FunctionGraph

param

String

Parameters (in JSON format) corresponding to the target service.

  • OBS: Parameters related to the bucket name, object name prefix, and object expiration time are included. The object expiration time ranges from 0 to 365 days. If the value is 0, the object has unlimited validity.

  • SMN: The topic_urn parameter is included.

  • DIS: The stream_name parameter is included.

  • FunctionGraph: The func_urn parameter is included.
Table 7 PageInfo

Parameter

Type

Description

next_marker

Long

Address of the next page.

Minimum: 0

previous_marker

Long

Address of the previous page.

Minimum: 0

current_count

Long

Number of records returned on the current page.

Minimum: 0

Example Requests

Obtain the asynchronous invocation configurations of all versions of a function.

GET https://{functiongraph_endpoint}/v2/{project_id}/fgs/functions/{function_urn}/async-invoke-configs?marker=0&limit=10

Example Responses

Status code: 200

Ok

{
  "async_invoke_configs" : [ {
    "func_urn" : "urn:fss:cn-north-7:5691ba790e2b46ceb38316xxxxxxxxxx:function:default:test_async:latest",
    "max_async_event_age_in_seconds" : 60,
    "max_async_retry_attempts" : 1,
    "destination_config" : {
      "on_success" : {
        "destination" : "FunctionGraph",
        "param" : "{\"func_urn\":\"urn:fss:cn-north-7:5691ba790e2b46ceb38316xxxxxxxxxx:function:default:testPython:latest\"}"
      },
      "on_failure" : {
        "destination" : "FunctionGraph",
        "param" : "{\"func_urn\":\"urn:fss:cn-north-7:5691ba790e2b46ceb38316xxxxxxxxxx:function:default:testPython:latest\"}"
      }
    },
    "created_time" : "2021-03-04T14:50:02+08:00",
    "last_modified" : "2021-03-04T14:50:02+08:00"
  } ],
  "count" : 2,
  "page_info" : {
    "next_marker" : 2,
    "previous_marker" : 0,
    "current_count" : 2
  }
}

Status Codes

Status Code

Description

200

Ok

400

Bad Request

404

Not Found

Error Codes

See Error Codes.