tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeProcedureTemplates

Last updated: 2024-03-27 16:08:07

    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 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.
    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:
  • Preset: preset task flow template;
  • Custom: custom task flow template.
    		•
    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, 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 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.

    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy