Last updated: 2020-08-14 09:41:30

1. API Description

Domain name for API request:

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.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example:

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 parameter. The value used for this API: CommitUpload.
Version Yes String Common parameter. The value used for this API: 2018-07-17.
Region Yes String Common parameter. 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 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.

3. Output Parameters

Parameter Name Type Description
FileId String Unique ID of media file.
MediaUrl String Media playback address.
Note: this field may return null, indicating that no valid values can be obtained.
CoverUrl String Media cover address.
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Successfully confirming upload

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "FileId": "24820810452266399",
    "MediaUrl": "",
    "CoverUrl": "",
    "RequestId": "requestId"

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.


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?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback