Video on Demand
- Release Notes and Announcements
- Announcements
- Product Introduction
- Features
- Media Upload
- Media Management
- Media Processing
- Ultimate Playback
- Media Intelligence
- Media Compliance
- Copyright Protection
- Solutions
- Professional Edition
- Console Guide
- Storage Management
- File Management
- Migration Tools
- Full Migration Tool
- Development Guide
- Purchase Guide
- Console Guide
- Application Management
- Media Management
- Media Asset Management
- Audio/Video Management
- Image Management
- Media Processing Settings
- Image Processing Settings
- Distribution and Playback Settings
- Managing Domain Names
- Package Management
- License Management
- User Generated Short Video SDK License
- Practical Tutorial
- Media Upload
- Video Processing
- Distribution and Playback
- Development Guide
- Media Upload
- Upload from Server
- Media Processing
- Video Processing
- Video Clipping
- Image Processing
- Event Notification
- Video Playback
- Hotlink Protection Settings
- Media Encryption and Copyright Protection
- DRM Encryption
- Player SDK
- Player Guide
- Integration (UI Included)
- Web Integration
- Integration (No UI)
- Web Integration
- iOS Integration
- Android Integration
- Flutter Integration
- Advanced Features
- Web Advanced Features
- Advanced Mobile Features
- Picture-in-Picture Component (TUIPIP)
- Player SDK Policy
- Server APIs
- Other APIs
- Media processing related API
- No longer recommended APIs
- Task Management APIs
- Media Upload APIs
- Media Management APIs
- Event Notification Relevant API
- Media Categorization APIs
- Domain Name Management APIs
- AI-based Sample Management APIs
- Region Management APIs
- Statistics APIs
- Carousel-Related APIs
- Just In Time Transcode APIs
- Making API Requests
- AI-based image processing APIs
- Parameter Template APIs
- Task Flow APIs
- FAQs
- Agreements
ExecuteFunction
Last updated: 2024-03-27 16:08:25
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.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
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 Params. The value used for this API: ExecuteFunction. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| FunctionName | Yes | String | Name of called backend API. |
| FunctionArg | Yes | String | API parameter. For specific parameter format, negotiate with the backend before calling. |
| SubAppId | No | Integer | The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID. |
| 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. |
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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Customer A initiating a custom video processing task
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
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 | Operation failed. |
| FailedOperation.InvalidVodUser | The VOD service is not activated. |
| InternalError | Internal error. |
| InvalidParameterValue.FunctionArg | Incorrect parameter value: FunctionArg. |
| InvalidParameterValue.FunctionName | Incorrect parameter value: FunctionName. |
| InvalidParameterValue.SessionContextTooLong | SessionContext is too long. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No