InvokeFunction - Function Compute - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

fc:InvokeFunction

create

*All Resource

*

None

Request syntax

POST /2023-03-30/functions/{functionName}/invocations HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
functionName	string	Yes	Function name	my-func

Request parameters

Parameter	Type	Required	Description	Example
qualifier	string	No	Function version or alias	LATEST
x-fc-invocation-type	string	No	Function invocation type. Sync or Async.	Sync
x-fc-log-type	string	No	Log type returned by function invocation. None or Tail.	Tail
body	string	No	Function invocation parameter	event
x-fc-async-task-id	string	No	Asynchronous task ID. Enable asynchronous tasks beforehand. Note When using the SDK for invocation, set a business-related ID. This helps with subsequent operations on the execution. For example, a video processing function can use the video filename as the invocation ID. Use this ID to check if the video processing is complete or to stop it. The ID naming convention must start with an English letter (uppercase or lowercase) or an underscore (_). It can contain English letters (uppercase or lowercase), digits (0-9), underscores (_), and hyphens (-). The ID cannot exceed 128 characters. If you do not set an ID for asynchronous invocation, the system automatically generates one.	test-id

Response elements

Element	Type	Description	Example
	string	Function invocation response	response

Examples

Success response

JSON format

"response"

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.