All Products
Search
Document Center

Function Compute:InvokeFunction

Last Updated:Sep 28, 2022

Invokes a function.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
X-Fc-Invocation-TypestringNo

The method used to invoke the function. Valid values:

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

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

Error codes

For a list of error codes, visit the API error center.

Change history

Change timeSummary of changesOperate
2021-06-29The internal configurations of the API operation has changed but you can still call the operation.
Change itemChange content
The internal configurations of the API operation has changed but you can still call the operation.
2021-06-29OpenAPI InvokeFunction is offline
Change itemChange content
2021-06-29The internal configurations of the API operation has changed but you can still call the operation.
Change itemChange content
The internal configurations of the API operation has changed but you can still call the operation.