ExecuteFunction

Last updated: 2020-03-27 18:45:42

1. API Description

Domain name for API request: vod.tencentcloudapi.com.

This API is only used in special scenarios of custom development. Unless requested by VOD customer service, please do not call it.

A maximum of 100 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: ExecuteFunction.
Version Yes String Common parameter. The value used for this API: 2018-07-17.
Region No String Common parameter. This parameter is not required for this API.
FunctionName Yes String Name of called backend API.
FunctionArg Yes String API parameter. For specific parameter format, negotiate with the backend before calling.
SessionContext No String The source context which is used to pass through the user request information. The task flow status change callback will return the value of this field. It can contain up to 1,000 characters.
SessionId No String The ID used for deduplication. If there was a request with the same ID in the last seven days, the current request will return an error. The ID can contain up to 50 characters. If this parameter is left empty or a blank string is entered, no deduplication will be performed.
ExtInfo No String Reserved field for special purposes.
SubAppId No Integer Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.

3. Output Parameters

Parameter Name Type Description
Result String String generated by packaging processing result. For specifications, negotiate with the backend.
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Initiating custom video processing by customer A

Input Example

https://vod.tencentcloudapi.com/?Action=ExecuteFunction
&FunctionName=ExampleFunc
&FunctionArg=XXX
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "8ad61e3a-6b8e-4b4e-9256-fdc701190064ef0",
    "Result": "XXX"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.InvalidVodUser The VOD service is not activated.
InternalError Internal error.
InvalidParameterValue.FunctionArg Incorrect parameter value: FunctionArg.
InvalidParameterValue.FunctionName Incorrect parameter value: FunctionName.
UnauthorizedOperation Unauthorized operation.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help