- Release Notes and Announcements
- Release Notes
- Announcements
- Notice about the adjustment of the VOD adding domain feature
- Announcement on official commercial billing of Video on Demand STANDARD_IA data retrieval and Application Management functions
- Announcement on the official launch of the Video-on-Demand QUIC Acceleration feature
- VOD Launched Remaster Feature
- Prepaid Packages Supported for Monthly Billed Accounts
- Cost Allocation by Tag Supported
- Content Moderation Upgraded
- VOD Player Signature Upgrade
- Live Clipping to Become Paid Feature
- Content Recognition to Become Paid Feature
- The “startPlay” API of the Player SDK Renamed
- TESHD Renamed as TSC
- Announcement on VOD Video Acceleration Price Change
- Launching Video on Demand (VOD) Features for Regions Outside the Chinese Mainland
- About Changing the Billing Rule of Transcoding Service for VOD/MPS
- Product Introduction
- Purchase Guide
- Getting Started
- Console Guide
- Console Overview
- Service Overview
- Application Management
- Media Management
- Package Management
- License Management
- Best Practice
- Media Upload
- Smart Cold Storage of VOD Media Asset Files
- Video Processing
- Distribution and Playback
- How to Receive Event Notification
- How to Migrate Files from Origin Server to VOD
- Live Recording
- How to Make VOD Videos Live Streaming-Like
- Using VOD and WordPress to Build a Website
- How to Pull from Custom Origin Servers
- Development Guide
- Player SDK
- Server APIs
- History
- Introduction
- API Category
- Making API Requests
- AI-based image processing APIs
- Parameter Template APIs
- DeleteHeadTailTemplate
- CreateHeadTailTemplate
- DescribeHeadTailTemplates
- ModifyHeadTailTemplate
- CreateEnhanceMediaTemplate
- DeleteEnhanceMediaTemplate
- ModifyEnhanceMediaTemplate
- DescribeEnhanceMediaTemplates
- CreateQualityInspectTemplate
- DeleteQualityInspectTemplate
- DescribeQualityInspectTemplates
- ModifyQualityInspectTemplate
- CreateWatermarkTemplate
- CreateSnapshotByTimeOffsetTemplate
- CreateSampleSnapshotTemplate
- CreateImageSpriteTemplate
- CreateAnimatedGraphicsTemplate
- CreateAdaptiveDynamicStreamingTemplate
- CreateAIRecognitionTemplate
- CreateAIAnalysisTemplate
- ModifyWatermarkTemplate
- ModifySnapshotByTimeOffsetTemplate
- ModifySampleSnapshotTemplate
- ModifyImageSpriteTemplate
- ModifyAnimatedGraphicsTemplate
- ModifyAdaptiveDynamicStreamingTemplate
- ModifyAIRecognitionTemplate
- ModifyAIAnalysisTemplate
- DescribeTranscodeTemplates
- DescribeWatermarkTemplates
- DescribeSnapshotByTimeOffsetTemplates
- DescribeSampleSnapshotTemplates
- DescribeImageSpriteTemplates
- DescribeAnimatedGraphicsTemplates
- DescribeAdaptiveDynamicStreamingTemplates
- DescribeAIRecognitionTemplates
- DescribeAIAnalysisTemplates
- DeleteTranscodeTemplate
- DeleteWatermarkTemplate
- DeleteSnapshotByTimeOffsetTemplate
- DeleteSampleSnapshotTemplate
- DeleteImageSpriteTemplate
- DeleteAnimatedGraphicsTemplate
- DeleteAdaptiveDynamicStreamingTemplate
- DeleteReviewTemplate
- DeleteAIRecognitionTemplate
- DeleteAIAnalysisTemplate
- CreateImageProcessingTemplate
- DeleteImageProcessingTemplate
- DescribeImageProcessingTemplates
- DescribeReviewTemplates
- CreateReviewTemplate
- CreateTranscodeTemplate
- ModifyReviewTemplate
- ModifyTranscodeTemplate
- No longer recommended APIs
- Task Flow APIs
- Task Management APIs
- Media Upload APIs
- Media Management APIs
- Event Notification Relevant API
- Media Categorization APIs
- Domain Name Management APIs
- Distribution APIs
- AI-based Sample Management APIs
- Region Management APIs
- Statistics APIs
- Playlist APIs
- Just In Time Transcode APIs
- Other APIs
- Data Types
- Error Codes
- FAQs
- Agreements
- VOD Policy
- Contact Us
- Glossary
- Release Notes and Announcements
- Release Notes
- Announcements
- Notice about the adjustment of the VOD adding domain feature
- Announcement on official commercial billing of Video on Demand STANDARD_IA data retrieval and Application Management functions
- Announcement on the official launch of the Video-on-Demand QUIC Acceleration feature
- VOD Launched Remaster Feature
- Prepaid Packages Supported for Monthly Billed Accounts
- Cost Allocation by Tag Supported
- Content Moderation Upgraded
- VOD Player Signature Upgrade
- Live Clipping to Become Paid Feature
- Content Recognition to Become Paid Feature
- The “startPlay” API of the Player SDK Renamed
- TESHD Renamed as TSC
- Announcement on VOD Video Acceleration Price Change
- Launching Video on Demand (VOD) Features for Regions Outside the Chinese Mainland
- About Changing the Billing Rule of Transcoding Service for VOD/MPS
- Product Introduction
- Purchase Guide
- Getting Started
- Console Guide
- Console Overview
- Service Overview
- Application Management
- Media Management
- Package Management
- License Management
- Best Practice
- Media Upload
- Smart Cold Storage of VOD Media Asset Files
- Video Processing
- Distribution and Playback
- How to Receive Event Notification
- How to Migrate Files from Origin Server to VOD
- Live Recording
- How to Make VOD Videos Live Streaming-Like
- Using VOD and WordPress to Build a Website
- How to Pull from Custom Origin Servers
- Development Guide
- Player SDK
- Server APIs
- History
- Introduction
- API Category
- Making API Requests
- AI-based image processing APIs
- Parameter Template APIs
- DeleteHeadTailTemplate
- CreateHeadTailTemplate
- DescribeHeadTailTemplates
- ModifyHeadTailTemplate
- CreateEnhanceMediaTemplate
- DeleteEnhanceMediaTemplate
- ModifyEnhanceMediaTemplate
- DescribeEnhanceMediaTemplates
- CreateQualityInspectTemplate
- DeleteQualityInspectTemplate
- DescribeQualityInspectTemplates
- ModifyQualityInspectTemplate
- CreateWatermarkTemplate
- CreateSnapshotByTimeOffsetTemplate
- CreateSampleSnapshotTemplate
- CreateImageSpriteTemplate
- CreateAnimatedGraphicsTemplate
- CreateAdaptiveDynamicStreamingTemplate
- CreateAIRecognitionTemplate
- CreateAIAnalysisTemplate
- ModifyWatermarkTemplate
- ModifySnapshotByTimeOffsetTemplate
- ModifySampleSnapshotTemplate
- ModifyImageSpriteTemplate
- ModifyAnimatedGraphicsTemplate
- ModifyAdaptiveDynamicStreamingTemplate
- ModifyAIRecognitionTemplate
- ModifyAIAnalysisTemplate
- DescribeTranscodeTemplates
- DescribeWatermarkTemplates
- DescribeSnapshotByTimeOffsetTemplates
- DescribeSampleSnapshotTemplates
- DescribeImageSpriteTemplates
- DescribeAnimatedGraphicsTemplates
- DescribeAdaptiveDynamicStreamingTemplates
- DescribeAIRecognitionTemplates
- DescribeAIAnalysisTemplates
- DeleteTranscodeTemplate
- DeleteWatermarkTemplate
- DeleteSnapshotByTimeOffsetTemplate
- DeleteSampleSnapshotTemplate
- DeleteImageSpriteTemplate
- DeleteAnimatedGraphicsTemplate
- DeleteAdaptiveDynamicStreamingTemplate
- DeleteReviewTemplate
- DeleteAIRecognitionTemplate
- DeleteAIAnalysisTemplate
- CreateImageProcessingTemplate
- DeleteImageProcessingTemplate
- DescribeImageProcessingTemplates
- DescribeReviewTemplates
- CreateReviewTemplate
- CreateTranscodeTemplate
- ModifyReviewTemplate
- ModifyTranscodeTemplate
- No longer recommended APIs
- Task Flow APIs
- Task Management APIs
- Media Upload APIs
- Media Management APIs
- Event Notification Relevant API
- Media Categorization APIs
- Domain Name Management APIs
- Distribution APIs
- AI-based Sample Management APIs
- Region Management APIs
- Statistics APIs
- Playlist APIs
- Just In Time Transcode APIs
- Other APIs
- Data Types
- Error Codes
- FAQs
- Agreements
- VOD Policy
- Contact Us
- Glossary
1. API Description
Domain name for API request: vod.tencentcloudapi.com.
This API is used to get the list of task flow template details by task flow template name.
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: DescribeProcedureTemplates. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| SubAppId | No | Integer | The VOD subapplication ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty. |
| Names.N | No | Array of String | Name filter of task flow template. Array length limit: 100. |
| Type | No | String | Filter of task flow template types. Valid values: |
| Offset | No | Integer | Pagination offset. Default value: 0. |
| Limit | No | Integer | Number of returned entries. Default value: 10. Maximum value: 100. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of eligible entries. |
| ProcedureTemplateSet | Array of ProcedureTemplate | List of task flow template details. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Query the specified task flow template
Query the details of the task flow template named "My Task Flow A"
Input Example
https://vod.tencentcloudapi.com/?Action=DescribeProcedureTemplates
&Names.0=My task flow A
&<Public Request Parameter>
Output Example
{
"Response": {
"TotalCount": 1,
"ProcedureTemplateSet": [
{
"Name": "My task flow A",
"Type": "Custom",
"Comment": "My task flow A",
"UpdateTime": "2018-10-01T18:00:00",
"CreateTime": "2018-10-01T18:00:00",
"MediaProcessTask": {
"TranscodeTaskSet": [
{
"Definition": 20,
"WatermarkSet": [],
"MosaicSet": [],
"TraceWatermark": {
"Switch": "OFF",
"Definition": 0
},
"StartTimeOffset": 0,
"CopyRightWatermark": {
"Text": ""
},
"HeadTailSet": [],
"EndTimeOffset": 0
},
{
"Definition": 30,
"WatermarkSet": [],
"MosaicSet": [],
"TraceWatermark": {
"Switch": "OFF",
"Definition": 0
},
"StartTimeOffset": 0,
"CopyRightWatermark": {
"Text": ""
},
"HeadTailSet": [],
"EndTimeOffset": 0
},
{
"Definition": 40,
"WatermarkSet": [],
"MosaicSet": [],
"TraceWatermark": {
"Switch": "OFF",
"Definition": 0
},
"StartTimeOffset": 0,
"CopyRightWatermark": {
"Text": ""
},
"HeadTailSet": [],
"EndTimeOffset": 0
}
],
"AnimatedGraphicTaskSet": [],
"SnapshotByTimeOffsetTaskSet": [],
"SampleSnapshotTaskSet": [],
"ImageSpriteTaskSet": [],
"CoverBySnapshotTaskSet": []
},
"AiContentReviewTask": null,
"AiAnalysisTask": null,
"AiRecognitionTask": null,
"MiniProgramPublishTask": null,
"ReviewAudioVideoTask": null
}
],
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3"
}
}
Example2 Query all task flow templates
Query the details of all task flow templates. A total of 3 task flow templates were found.
Input Example
https://vod.tencentcloudapi.com/?Action=DescribeProcedureTemplates
&<Public Request Parameter>
Output Example
{
"Response": {
"TotalCount": 3,
"ProcedureTemplateSet": [
{
"Name": "My task flow A",
"Type": "Custom",
"Comment": "My task flow A",
"UpdateTime": "2018-10-01T18:00:00",
"CreateTime": "2018-10-01T18:00:00",
"MediaProcessTask": {
"TranscodeTaskSet": [
{
"Definition": 20,
"WatermarkSet": [],
"MosaicSet": [],
"TraceWatermark": {
"Switch": "OFF",
"Definition": 0
},
"StartTimeOffset": 0,
"CopyRightWatermark": {
"Text": ""
},
"HeadTailSet": [],
"EndTimeOffset": 0
},
{
"Definition": 30,
"WatermarkSet": [],
"MosaicSet": [],
"TraceWatermark": {
"Switch": "OFF",
"Definition": 0
},
"StartTimeOffset": 0,
"CopyRightWatermark": {
"Text": ""
},
"HeadTailSet": [],
"EndTimeOffset": 0
},
{
"Definition": 40,
"WatermarkSet": [],
"MosaicSet": [],
"TraceWatermark": {
"Switch": "OFF",
"Definition": 0
},
"StartTimeOffset": 0,
"CopyRightWatermark": {
"Text": ""
},
"HeadTailSet": [],
"EndTimeOffset": 0
}
],
"AnimatedGraphicTaskSet": [],
"SnapshotByTimeOffsetTaskSet": [],
"SampleSnapshotTaskSet": [],
"ImageSpriteTaskSet": [],
"CoverBySnapshotTaskSet": []
},
"AiContentReviewTask": null,
"AiAnalysisTask": null,
"AiRecognitionTask": null,
"MiniProgramPublishTask": null,
"ReviewAudioVideoTask": null
},
{
"Name": "My task flowB",
"Type": "Custom",
"Comment": "My task flowB",
"UpdateTime": "2018-10-01T18:00:00",
"CreateTime": "2018-10-01T18:00:00",
"MediaProcessTask": {
"TranscodeTaskSet": [
{
"Definition": 20,
"WatermarkSet": [
{
"Definition": 15780,
"TextContent": ""
}
],
"MosaicSet": [],
"TraceWatermark": {
"Switch": "OFF",
"Definition": 0
},
"StartTimeOffset": 0,
"CopyRightWatermark": {
"Text": ""
},
"HeadTailSet": [],
"EndTimeOffset": 0
},
{
"Definition": 30,
"WatermarkSet": [
{
"Definition": 15780,
"TextContent": ""
}
],
"MosaicSet": [],
"TraceWatermark": {
"Switch": "OFF",
"Definition": 0
},
"StartTimeOffset": 0,
"CopyRightWatermark": {
"Text": ""
},
"HeadTailSet": [],
"EndTimeOffset": 0
},
{
"Definition": 40,
"WatermarkSet": [
{
"Definition": 15780,
"TextContent": ""
}
],
"MosaicSet": [],
"TraceWatermark": {
"Switch": "OFF",
"Definition": 0
},
"StartTimeOffset": 0,
"CopyRightWatermark": {
"Text": ""
},
"HeadTailSet": [],
"EndTimeOffset": 0
}
],
"AnimatedGraphicTaskSet": [],
"SnapshotByTimeOffsetTaskSet": [],
"SampleSnapshotTaskSet": [],
"ImageSpriteTaskSet": [],
"CoverBySnapshotTaskSet": []
},
"AiContentReviewTask": null,
"AiAnalysisTask": null,
"AiRecognitionTask": null,
"MiniProgramPublishTask": null,
"ReviewAudioVideoTask": null
},
{
"Name": "My task flowC",
"Type": "Custom",
"Comment": "My task flowC",
"UpdateTime": "2018-10-01T18:00:00",
"CreateTime": "2018-10-01T18:00:00",
"MediaProcessTask": null,
"AiContentReviewTask": {
"Definition": 10
},
"AiAnalysisTask": null,
"AiRecognitionTask": null,
"MiniProgramPublishTask": null,
"ReviewAudioVideoTask": null
}
],
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3"
}
}
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
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.Limit | Invalid parameter: Limit. |
| InvalidParameterValue.Names | Too many elements in the Names array. |
| InvalidParameterValue.Type | Incorrect Type parameter value. |
| UnauthorizedOperation | Unauthorized operation. |
Yes
No
Was this page helpful?