Skip to main content

Cloud Function

invoke

1. API Description

Function: Function Execution

2. Request URL

POST https://tcb-api.tencentcloudapi.com/api/v2/envs/${envId}/functions/${functionName}:invoke

3. Request Body

FieldTypeRequiredDescription
dataObjectNoCloud Function invocation request parameters

4. Response Body

FieldTypeRequiredDescription
statusCodeNumberRequiredStatus code, 200
bodyObjectRequiredResponse body, structure as follows
body
FieldTypeRequiredDescription
requestIdStringNoRequest ID
dataObjectNoReturn result
codeStringNoError code
messageStringNoError message
data
FieldTypeRequiredDescription
response_dataStringRequiredJSON-serialized string of the custom function response

5. Usage Example

// Node Example
const request = require("request"); // Request library, requires npm installation of dependencies
const envId = "testEnv"; // Environment ID

request(
{
url: `https://tcb-api.tencentcloudapi.com/api/v2/envs/${envId}/functions/${functionName}:invoke`,
method: "POST",
headers: {
"X-CloudBase-Authorization": "your authorization",
"X-CloudBase-SessionToken": "your token",
"X-CloudBase-TimeStamp": "the timestamp"
},
body: {
data: {
key: value
}
},
json: true
},
(err, response, body) => {
console.log(err);
console.log(response.statusCode);
console.log(response.body.data);
}
);