All Products
Search

This Product

    Function Compute:InvokeFunction

    Document Center

    Function Compute:InvokeFunction

    Last Updated:Sep 19, 2024

    Invoke a function.

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

    Request syntax

    POST /2021-04-06/services/{serviceName}/functions/{functionName}/invocations

    Request parameters

    ParameterTypeRequiredDescriptionExample
    X-Fc-Invocation-TypestringNo

    The invocation method. Valid values:

    • Sync: synchronous invocations
    • Async: asynchronous invocations

    Default value: Sync

    		Sync
    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.
    		None
    serviceNamestringYes

    The name of the service.

    		demoService
    qualifierstringNo

    The version or alias of the service.

    		demoQualifier
    functionNamestringYes

    The name of the function.

    		demoFunction
    bodybyteNo

    The event to be processed by the function. Set this parameter to a binary string. Function Compute passes the event to the function for processing.

    		{"key":"value"}
    X-Fc-Stateful-Async-Invocation-IdstringNo

    The ID of the asynchronous task. You must enable the asynchronous task feature in advance.

    Note When you use an SDK to invoke a function, we recommend that you specify a business-related ID to facilitate subsequent operations. For example, you can use the video name as the invocation ID for a video-processing function. This way, you can use the ID to check whether the video is processed or terminate the processing of the video. The ID must start with a letter or an underscore (_) and can contain letters, digits, underscores (_), and hyphens (-). The ID can be up to 128 characters in length. If you do not specify the ID of the asynchronous invocation, Function Compute automatically generates an ID.
    		test-invoke-id
    X-Fc-Stateful-Async-Invocation-EnablestringNo

    Specifies whether to enable the asynchronous task mode for requests. Default value: false. Valid values:

    • true
    • false
    Note This parameter takes effect only for asynchronous invocations. It does not take effect for synchronous invocations.
    		true
    X-Fc-Account-IdstringNo

    The ID of your Alibaba Cloud account.

    		188077086902****
    X-Fc-DatestringNo

    The time when the function is invoked. The format is EEE,d MMM yyyy HH:mm:ss GMT.

    		Wed, 11 May 2022 09:00:00 GMT
    X-Fc-Trace-IdstringNo

    The trace ID of the request for Function Compute API. The value is the same as that of the requestId parameter in the response.

    		test-trace-id

    Response parameters

    ParameterTypeDescriptionExample
    headersobject
    X-Fc-Error-Typestring

    The type of the error returned if the function invocation fails. Valid values: HandledInvocationError and UnhandledInvocationError.

    		UnhandledInvocationError
    X-Fc-Log-Resultstring

    The Tail result of the log generated by calling the function.

    		demo log result
    X-Fc-Code-Checksumstring

    Code verification.

    		5697641582914695457
    X-Fc-Invocation-Durationnumber

    The function execution duration. Unit: seconds.

    		10
    X-Fc-Max-Memory-Usagenumber

    The maximum memory consumed by the function execution. Unit: MB.

    		50
    byte

    The return value for the request.

    		hello world

    Examples

    Sample success responses

    JSONformat

    "hello world"

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-05-30The request parameters of the API has changedView Change Details
    2021-06-29The internal configuration of the API is changed, but the call is not affectedView Change Details
    2021-06-29The internal configuration of the API is changed, but the call is not affectedView Change Details