Contents:
1. API Description
API request domain name: scf.tencentcloudapi.com.
This API runs the function.
Default API request frequency limit: 20 times/second.
2. Input Parameters
The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.
Parameter name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common parameter; the name of this API: Invoke |
Version | Yes | String | Common parameter; the version of this API: 2018-04-16 |
Region | Yes | String | Common parameters; for details, see the Region List. |
FunctionName | Yes | String | Name of the function |
InvocationType | No | String | RequestResponse (sync) and Event (asynchronous); sync by default |
Qualifier | No | String | Version number that triggers the function |
ClientContext | No | String | Parameters when executing the function; input in JSON format; the maximum supported parameter size is 1 MB |
LogType | No | String | |
Namespace | No | String | Namespace |
3. Output Parameters
Parameter name | Type | Description |
---|---|---|
Result | Result | Execution result of the function |
RequestId | String | The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues. |
4. Sample
Executing a Function
Input Sample Code
https://scf.tencentcloudapi.com/?Action=Invoke
&FunctionName=xxxx
&<Common request parameter>
Output Sample Code
{
"Response": {
"Result": {
"MemUsage": 3207168,
"Log": "",
"RetMsg": "hello from scf",
"BillDuration": 100,
"FunctionRequestId": "6add56fa-58f1-11e8-89a9-5254005d5fdb",
"Duration": 0.826,
"ErrMsg": "",
"InvokeResult": 0
},
"RequestId": "c2af8a64-c922-4d55-aee0-bd86a5c2cd12"
}
}
5. Developer Resources
API Explorer
This tool provides various capabilities such as online call, signature verification, SDK code generation, and quick API retrieval that significantly reduce the difficulty of using TencentCloud API.
6. Error Codes
The following error codes are API business logic-related. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InternalError | Internal error |
InternalError.System | Internal system error. |
InvalidParameterValue | An invalid value was declared for the input parameter. |
InvalidParameterValue.Param | The input parameter is not in standard JSON format. |
ResourceNotFound.FunctionName | Function does not exist. |
ResourceUnavailable.InsufficientBalance | The balance is insufficient. Please top up first. |
UnauthorizedOperation.CAM | CAM authentication failed. |