Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to search the task flow template detail list based on the task flow template name.
A maximum of 100 requests can be initiated per second for this API.
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 | Video-on-demand (VOD) application ID. For customers who activate VOD services from December 25, 2023, if they access resources in VOD applications (whether the default application or a newly created application), this field must be set to the app ID. |
| Names.N | No | Array of String | Task flow template name filter conditions. The array can contain up to 100 names. |
| Type | No | String | Filtering condition for the task flow template type. Available values: |
| Offset | No | Integer | Paging offset. Default value: 0. |
| Limit | No | Integer | Number of returned entries. Default value: 10. Maximum value: 100. |
| SortBy.N | No | Array of SortBy | Sort the returned results by the specified field in ascending or descending order. Sort.Field currently only supports CreateTime. Sort.Order is desc (descending) or asc (ascending). Input parameter limit: currently only supports CreateTime as the sorting field. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of records that meet filter conditions. |
| ProcedureTemplateSet | Array of ProcedureTemplate | Task flow template detail list. |
| 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. |
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProcedureTemplates
<Common request parameters>
{
"SubAppId": 221094,
"SortBy": [
{
"Field": "create_time",
"Order": "desc"
}
]
}{
"Response": {
"ProcedureTemplateSet": [
{
"AiAnalysisTask": null,
"AiContentReviewTask": null,
"AiRecognitionTask": null,
"AiRecognitionTaskSet": [],
"Comment": "",
"CreateTime": "2026-05-12T14:58:40+08:00",
"MediaProcessTask": {
"AdaptiveDynamicStreamingTaskSet": [],
"AnimatedGraphicTaskSet": [],
"CoverBySnapshotTaskSet": [],
"ImageSpriteTaskSet": [],
"SampleSnapshotTaskSet": [],
"SnapshotByTimeOffsetTaskSet": [],
"TranscodeTaskSet": [
{
"BlindWatermark": null,
"CopyRightWatermark": {
"Text": ""
},
"Definition": 1140,
"EndTimeOffset": 0,
"HeadTailSet": [],
"MosaicSet": [],
"OverrideParameter": null,
"StartTimeOffset": 0,
"SubtitleInfoSet": [],
"TraceWatermark": {
"Definition": 0,
"Switch": ""
},
"WatermarkSet": []
}
]
},
"MiniProgramPublishTask": null,
"Name": "hy-test2",
"ReviewAudioVideoTask": null,
"Type": "Custom",
"UpdateTime": "2026-05-12T14:58:40+08:00"
}
],
"TotalCount": 5,
"RequestId": "884b286f-de85-4065-a5d5-64ce54dfe5bf"
}
}POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProcedureTemplates
<Common request parameters>
{
"SubAppId": 221094
}{
"Response": {
"ProcedureTemplateSet": [
{
"AiAnalysisTask": null,
"AiContentReviewTask": null,
"AiRecognitionTask": {
"Definition": 70
},
"AiRecognitionTaskSet": [],
"Comment": "",
"CreateTime": "2019-10-23T20:47:15+08:00",
"MediaProcessTask": {
"AdaptiveDynamicStreamingTaskSet": [],
"AnimatedGraphicTaskSet": [],
"CoverBySnapshotTaskSet": [],
"ImageSpriteTaskSet": [],
"SampleSnapshotTaskSet": [],
"SnapshotByTimeOffsetTaskSet": [],
"TranscodeTaskSet": [
{
"BlindWatermark": null,
"CopyRightWatermark": {
"Text": ""
},
"Definition": 1010,
"EndTimeOffset": 0,
"HeadTailSet": [],
"MosaicSet": [],
"OverrideParameter": null,
"StartTimeOffset": 0,
"SubtitleInfoSet": [],
"TraceWatermark": {
"Definition": 0,
"Switch": ""
},
"WatermarkSet": []
}
]
},
"MiniProgramPublishTask": null,
"Name": "default",
"ReviewAudioVideoTask": null,
"Type": "Preset",
"UpdateTime": "2019-10-23T20:47:15+08:00"
}
],
"TotalCount": 5,
"RequestId": "84dc6ce1-df4c-4950-88a4-1d9c4cf96e2d"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | Parameter error: Limit. |
| InvalidParameterValue.Names | Too many elements in the Names array. |
| InvalidParameterValue.Type | Type parameter value error. |
| UnauthorizedOperation | Unauthorized operation. |
文档反馈