Invokes a function.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| fc:InvokeFunction | create | *All Resources * |
| none |
Request syntax
POST /2023-03-30/functions/{functionName}/invocations HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| functionName | string | Yes | The function name. | my-func |
| qualifier | string | No | The version or alias of the function. | LATEST |
| x-fc-invocation-type | string | No | The type of function invocation. Valid values: Sync and Async. | Sync |
| x-fc-log-type | string | No | The log type of function invocation. Valid values: None and Tail. | Tail |
| body | byte | No | The request parameters of function invocation. | event |
| x-fc-async-task-id | string | No | The ID of the asynchronous task. You must enable the asynchronous task feature in advance. Note
If you use an SDK to invoke a function, we recommend that you specify a business-related ID to facilitate subsequent operations. For example, a video processing function can use video file names as invocation IDs. This way, you can easily check whether a video is successfully processed or terminated before it is processed. The ID can start only with letters or underscores. An ID can contain letters, digits (0 - 9), underscores, and hyphens (-). It can be up to 128 characters in length. If you do not specify the ID of the asynchronous invocation, the system automatically generates an ID.
| test-id |
Response parameters
Examples
Sample success responses
JSONformat
"response"Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-04-13 | The request parameters of the API has changed | View Change Details |
| 2024-02-22 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2023-08-30 | API Description Update | View Change Details |
| 2023-08-30 | API Description Update. The response structure of the API has changed | View Change Details |
| 2023-07-05 | The request parameters of the API has changed | View Change Details |
| 2023-06-28 | Add Operation | View Change Details |