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.
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: DescribeProcedureTemplates. |
| 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. |
| 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. |
| 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. |
| 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. |
This example shows you how to query the details of the task flow template named "My Task Flow A".
https://vod.tencentcloudapi.com/?Action=DescribeProcedureTemplates
&Names.0=My Task Flow A
&<Common request parameters>{
"Response": {
"TotalCount": 1,
"ProcedureTemplateSet": [
{
"Name": "My Task Flow A",
"Type": "Custom",
"MediaPrcoessTask": {
"TranscodeTaskSet": [
{
"Definition": 20,
"WatermarkSet": null
},
{
"Definition": 30,
"WatermarkSet": null
},
{
"Definition": 40,
"WatermarkSet": null
}
],
"AnimatedGraphicTaskSet": null,
"SnapshotByTimeOffsetTaskSet": null,
"SampleSnapshotTaskSet": null,
"ImageSpriteTaskSet": null,
"CoverBySnapshotTaskSet": null
},
"AiContentReviewTask": null,
"AiAnalysisTask": null,
"AiRecognitionTask": null,
"MiniProgramPublishTask": null
}
],
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3"
}
}This example shows you how to query the details of all task flow templates (3 templates are queried).
https://vod.tencentcloudapi.com/?Action=DescribeProcedureTemplates
&<Common request parameters>{
"Response": {
"TotalCount": 3,
"ProcedureTemplateSet": [
{
"Name": "My Task Flow A",
"Type": "Custom",
"MediaPrcoessTask": {
"TranscodeTaskSet": [
{
"Definition": 20,
"WatermarkSet": null
},
{
"Definition": 30,
"WatermarkSet": null
},
{
"Definition": 40,
"WatermarkSet": null
}
],
"AnimatedGraphicTaskSet": null,
"SnapshotByTimeOffsetTaskSet": null,
"SampleSnapshotTaskSet": null,
"ImageSpriteTaskSet": null,
"CoverBySnapshotTaskSet": null
},
"AiContentReviewTask": null,
"AiAnalysisTask": null,
"AiRecognitionTask": null,
"MiniProgramPublishTask": null
},
{
"Name": "My Task Flow B",
"Type": "Custom",
"MediaPrcoessTask": {
"TranscodeTaskSet": [
{
"Definition": 20,
"WatermarkSet": [
{
"Definition": 15780,
"TextContent": null
}
]
},
{
"Definition": 30,
"WatermarkSet": [
{
"Definition": 15780,
"TextContent": null
}
]
},
{
"Definition": 40,
"WatermarkSet": [
{
"Definition": 15780,
"TextContent": null
}
]
}
],
"AnimatedGraphicTaskSet": null,
"SnapshotByTimeOffsetTaskSet": null,
"SampleSnapshotTaskSet": null,
"ImageSpriteTaskSet": null,
"CoverBySnapshotTaskSet": null
},
"AiContentReviewTask": null,
"AiAnalysisTask": null,
"AiRecognitionTask": null,
"MiniProgramPublishTask": null
},
{
"Name": "My Task Flow C",
"Type": "Custom",
"MediaPrcoessTask": null,
"AiContentReviewTask": {
"Definition": 10
},
"AiAnalysisTask": null,
"AiRecognitionTask": null,
"MiniProgramPublishTask": null
}
],
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3"
}
}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 | Invalid parameter: Limit. |
| InvalidParameterValue.Names | Too many elements in the Names array. |
| InvalidParameterValue.Type | Incorrect Type parameter value. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?