tencent cloud

All product documents
APIs
DocumentationAPIsVideo on DemandMedia Upload APIsCommitUpload
CommitUpload
Last updated: 2024-03-27 16:08:34
CommitUpload
Last updated: 2024-03-27 16:08:34

1. API Description

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

This API is used to confirm the result of uploading a media file (and cover file) to VOD, store the media information, and return the playback address and ID of the file.

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: CommitUpload.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
VodSessionKey Yes String VOD session, which takes the returned value (VodSessionKey) of the ApplyUpload API.
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.

3. Output Parameters

Parameter Name Type Description
FileId String Unique ID of media file.
MediaUrl String The media playback URL.
CoverUrl String The thumbnail URL.
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 Checking the result of an upload task

Input Example

https://vod.tencentcloudapi.com/?Action=CommitUpload
&VodSessionKey=3KEGq9DWHl1xF819mM4jVFkGn5WON80NwN/rTrx56UoEFApIV9DQ7t5m1g4hASR11gKWwGxkignB3AmhKOpUnym7wyNEHOwDJPcT5fBu66iCLcW7bhyRfDSsQcVpX0Wt96RKSsZFf62jeAB+e5640U8rMPV3Rf2eR+y1AgI+EC3JZU5iZbjLX4qNVI4R
&SubAppId=1
&<Common request parameters>

Output Example

{
    "Response": {
        "FileId": "24820810452266399",
        "MediaUrl": "http://251000333.vod2.myqcloud.com/6c0f1c00vodgzp251000333/dee2125c24820810452266399/f0.mp4",
        "CoverUrl": "http://251000333.vod2.myqcloud.com/6c0f1c00vodgzp251000333/dee2125c24820810452266399/24820810452266400.jpg",
        "RequestId": "requestId"
    }
}

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
InternalError Internal error.
InvalidParameterValue.SubAppId Incorrect parameter value: subapplication ID
InvalidParameterValue.VodSessionKey Incorrect parameter value: VOD session.
ResourceNotFound The resource does not exist.
UnauthorizedOperation Unauthorized operation.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

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

Contact Us
Technical Support

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

Submit a Ticket
7x24 Phone Support