tencent cloud



Last updated: 2024-03-27 16:09:28

    1. API Description

    Domain name for API request: vod.tencentcloudapi.com.

    Rebuild media by template.

    A maximum of 20 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: RebuildMediaByTemplate.
    Version Yes String Common Params. The value used for this API: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    FileId Yes String The file ID.
    Definition Yes Integer Rebuild Media Template ID.
    SubAppId No String 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.
    StartTimeOffset No Float The start offset (seconds). If you do not specify this, the segment will start from the beginning of the video.
    EndTimeOffset No Float The end offset (seconds). If you do not specify this, the segment will end at the end of the video.
    OutputConfig No RebuildMediaOutputConfig New file configuration after rebuild.
    SessionId No String The session ID, which is used for de-duplication. If there was a request with the same session ID in the last three days, an error will be returned for the current request. The session ID can contain up to 50 characters. If you do not pass this parameter or pass in an empty string, duplicate sessions will not be identified.
    SessionContext No String The source context, which is used to pass through user request information. The ProcedureStateChanged callback will return the value of this parameter. It can contain up to 1,000 characters.
    TasksPriority No Integer The task priority, which can be a value from -10 to 10. The higher the value, the higher the priority. If this parameter is left empty, 0 will be used.
    ExtInfo No String A reserved parameter.

    3. Output Parameters

    Parameter Name Type Description
    TaskId String The task ID of the rebuild, through which the status of the rebuild task can be queried.
    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 Rebuild media by template.

    Rebuild media by template.

    Input Example

    POST / HTTP/1.1
    Host: vod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: RebuildMediaByTemplate
    <Public Request Parameter>
        "FileId": "8312960950918954859",
        "Definition": 20001

    Output Example

        "Response": {
            "TaskId": "125xxx-RebuildMedia-75e45d323ffad76987112fafe2eb87dxxx",
            "RequestId": "ef5aae86-6eab-4cb3-9ebc-0979010b3f22"

    5. Developer Resources


    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

    There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support