- What's New
- Function Overview
- Service Overview
- Getting Started
-
User Guide
- Prerequisites
- Functions
- Permissions Management
- Domain Name Management
- Audio/Video Upload
- Media Asset Management
- Video Processing
- Global Settings
- Review Management (in OBT)
- Usage Query
- Data Analysis
- Viewing Monitoring Metrics
- Querying Real-Time Traces
- Appendix
- Best Practices
-
API Reference
- Before You Start
- API Overview
- Calling APIs
- Application Examples
- Key query
- Watermark template management
- Media Asset Storage Mode Management
- Media file pre-loading
- Media file processing
- Statistical analysis
- Transcoded Output Management
- Media file category
- Media file management
- Transcoding template management
- Uploads media files
- Subtitle management
- Transcoding template set management
- Historical APIs
- Appendix
- Change History
- SDK Reference
-
FAQs
-
Product Consulting
- What Is the Relationship Between VOD and OBS?
- Is VOD Only Available on Huawei Cloud ECSs?
- Do I Need to Buy the CDN Service Before Using VOD?
- What Is CDN Used for?
- Do I Need to Obtain a License Before Running a VOD Business?
- What Is the Host IP Address for?
- Do I Need to Enable OBS Before Using VOD?
- Is There a Bandwidth Limit for Playing Videos Using VOD?
- Does VOD Support Real-Time Monitoring?
-
Billing
- How Long Is the Retention Period for My Resources After My Account Goes Into Arrears?
- Do I Need to Unsubscribe from VOD If I Do Not Use It?
- How Is VOD Traffic Billed?
- How Is a Transcoding Template Group Billed?
- How Is URL Pull Billed?
- How Do I Calculate the VOD CDN Traffic?
- How Is a Workflow Billed?
- Will I Be Billed Again If I Use the Same Device ID to Watch a Video Repeatedly?
- Is Audio and Video Review Charged?
-
Permissions Management
- Why Can't an IAM User View Media Files Uploaded by the Account on the Console?
- How Do I Implement Access Control on Uploaded Media Files?
- What Permissions Do I Need for Uploading Media Files?
- Does VOD Support User Group Permissions?
- Why Can't an IAM User Log In to the VOD Console After Obtaining the VOD FullAccess Permission?
-
Domain Name Management
- Do I Need to Prepare a Domain Name Before Using VOD?
- Can I Use My Own Domain Name?
- Why Can't I Add a Domain Name?
- How Do I Check Whether a Domain Name Has Been Enabled?
- How Many Domain Names Can I Add to One Account?
- How Do I Configure HTTPS Secure Acceleration?
- What Can I Do If the Message "The certificate and domain name do not match." Is Displayed During HTTPS Certificate Configuration?
- How Do I Use Different Domain Names Simultaneously When Multiple Domain Names Are Configured for VOD?
- Why Does the Domain Name Status Remain "Configuring"?
- Notifications
-
Upload
- What Media File Formats Does VOD Support?
- How Are Media Files Uploaded to VOD?
- Can I Upload Compressed Video Files?
- Is There Any Limit on the File Upload Size?
- Is There Any Limit on the Total Size of Videos?
- What Is the Maximum Length of a Video File Name?
- Why Does Video Uploading Take So Long?
- Why Can't the File Length Be Obtained After a Media File Is Uploaded to VOD?
- Does VOD Support Resumable Upload?
- How Do I Avoid Uploading Duplicate Files?
- Why Can't I Find My Video on the Console After a Video Has Been Uploaded?
- Why Am I Logged Out Automatically? Will This Cause Upload Failure?
- When Can I Play an Uploaded Media File?
- How Long Does It Take to Upload a Video File?
- Why Can't I Upload Media Files?
- Why Is the Thumbnail Not Displayed After Being Uploaded on the Console?
- Can I Upload Videos Using WeChat Mini Programs?
- Do I Need to Upload a Thumbnail for an Uploaded Video?
-
Media Processing
- How Do I View Video Details Locally?
- How Do I Add Subtitles to a Video?
- How Do I Export All Media Details from the VOD Console?
- Why Can't I View All Uploaded Video Files on the Snapshots Page?
- Does the Duration on Audio and Video Management Page Refer to the Duration of the Input File or the Transcoded Output?
- Does VOD Have System Presets?
- Which Input Formats Does VOD Transcoding Support?
- Which Output Formats Does VOD Support?
- How Do I Convert a Video to Multiple Outputs in Different Resolutions?
- Can I Use Multiple Transcoding Templates for a Video While Transcoding?
- Will I Be Billed for the Index File Generated After Transcoding to the HLS Format?
- Why Is the Output Resolution Inconsistent with That Configured in the Transcoding Template?
- Why Is Transcoding Sometimes Fast and Sometimes Slow?
- Does the Input Resolution for Video Transcoding Support 8K?
- Does Transcoding Change the Size of Audio and Video Files?
- Why Do I Fail to Delete a Media File?
- Why Only Two Outputs Are Created When Three Outputs Are Set in the Transcoding Template?
- Does VOD Support Transcoding Callbacks?
- Why Is the Video Duration Different from That Displayed in the Player After Video Transcoding or Segmentation?
- Why Does CDN Pre-loading Fail?
- Why Can't I Delete a Watermark Template?
-
Playback
- What Are the Differences Between DASH, HLS, and MP4 Files?
- How Do I Obtain the Streaming URL of a Media File?
- How Do I Play Media Files on a Mobile Device?
- Which Types of Files Can Be Previewed on the VOD Console?
- What If I Failed to Play HLS Videos?
- How Do I Stop HLS Videos from Freezing?
- What If the Uploaded Video File Can't Be Played?
- Can I Create a QR Code for My Video Playback URL?
- Do I Need to Transcode an Uploaded Video Before Playing It?
- Why Does a Video Fail to Be Played Using My Own Domain Name?
- Can I Play a Video If I Don't Buy a Transcoding Package?
- Why Does the Encrypted HLS Video Playback Failed?
- Is There Any Limit on the Number of Online Viewers?
- Why An Error Code 403 Is Returned When I Access the Playback URL?
- Can I Use My Own Player to Play Media Files Uploaded to VOD?
- Can I Replace the Domain Name in the Generated Playback URL with My Own Domain Name?
- How Do I Fix a Blurry Video?
- Why Can't I Obtain the Streaming URL of a Transcoded Video?
- Why Does Frame Freezing Occur During the Playback of a Transcoded Video?
- Why Cannot a Transcoded M3U8 Video Be Played After URL Validation Is Configured?
- Why Can't an Encrypted HLS Video Be Played After Being Transcoded for the Second Time?
-
APIs and SDKs
- How Do I Obtain a Temporary AK/SK Pair and Security Token?
- Why Is the File Duration Returned 0 When I Call the API for Querying Media Details?
- How Do I Fix the Error of "Failed to verify the tenant ID" When I Call a VOD API?
- Why Is"The throttling threshold has been reached" Returned When I Call an API to Delete a Media File?
- Does task_id Returned Mean that My Pre-loading Task Has Been Completed?
- What Should I Do If the Frequency of Calling the Key Query API Exceeds 100 Times per Minute?
- Why Is a Message Displayed Indicating that the Current Media File or Resource Status Does Not Support This Operation During Media File Processing?
- What Are the Programming Languages Supported by the Server SDK?
- Why Are the source_path and output_path Parameters Empty in the Return Result When the API for Querying Details About a Specified Media File Is Called?
- How Do I Delete an Uploaded Multipart Video If the Upload Is Canceled When the API Is Called to Upload a Video?
- Why Can't I Obtain the Thumbnail After Calling the API for Uploading a Video File?
- How Do I Set the Validity Period of the AK/SK and Security Token?
- Why Can't I Preview the Watermark Image on the Console After Calling the API for Image Upload?
-
Security
- How Do I Protect Audio and Video from Piracy?
- How Do I Prevent Secondary Distribution After Audios and Videos Are Downloaded?
- Does HLS Encryption Provide One Key for Each Video? Will the Key Expire?
- How Do I Encrypt Transcoded Videos Using HLS?
- What Is a Key URL? How Do I Obtain It?
- What If the URL Validation Expires?
- Can Audio Files Be Encrypted During HLS Encryption?
- What Are the Differences Between HLS Encryption and Hotlink Protection?
- Can Encrypted Videos Be Played After the URL for Obtaining Keys Is Changed?
- Will a Signed URL Become Invalid During Playback?
- Why Does the Encrypted HLS URL in the Original Streaming URL Remain Unchanged After the Encrypted HLS URL Is Changed?
- Does VOD Support the Function of Only Watching Videos on CloudSite But Not Downloading Them?
- Are Self-Signed HTTPS Certificates Supported?
- Statistics Analysis
-
Product Consulting
- Troubleshooting
- Videos
- General Reference
- Media Asset Upload
- Media Asset Processing
- Media Asset Management
- Media Asset Prefetch
- Media Asset Categorization
- Key Query
- Statistical Analysis
- Watermark Template Management
- Subtitle Management
- Transcoding Template Management
- Transcoding Template Set Management
- Transcoded Output Management
- Media Asset Storage Mode Management
Show all
Copied.
API Overview
The following tables list the VOD APIs. Before calling a VOD API, you need to obtain a user token. The obtained token can then be used to authenticate the calling of other APIs. For details about how to call a VOD API, see Application Examples.
Media Asset Upload
|
API |
Description |
|---|---|
|
POST /v1.0/{project_id}/asset |
|
|
GET /v1.1/{project_id}/asset/authority |
|
|
POST /v1.0/{project_id}/asset/status/uploaded |
|
|
PUT /v1.0/{project_id}/asset/authority |
|
|
POST /v1.0/{project_id}/asset/reproduction |
|
|
POST /v1.0/{project_id}/asset/upload_by_url |
|
|
GET /v1.0/{project_id}/asset/duplication |
Media Asset Processing
|
API |
Description |
|---|---|
|
PUT /v1.0/{project_id}/asset |
|
|
POST /v1.0/{project_id}/asset/process |
|
|
DELETE /v1.0/{project_id}/asset/process |
|
|
POST /v1.0/{project_id}/asset/extract_audio |
|
|
DELETE /v1.0/{project_id}/asset/extract_audio |
|
|
PUT /v1.0/{project_id}/asset/cover |
Media Asset Management
|
API |
Description |
|---|---|
|
DELETE /v1.0/{project_id}/asset |
|
|
POST /v1.0/{project_id}/asset/status/publish |
|
|
POST /v1.0/{project_id}/asset/status/unpublish |
|
|
GET /v1.0/{project_id}/asset/info |
|
|
PUT /v1.0/{project_id}/asset/info |
|
|
GET /v1.0/{project_id}/asset/details |
|
|
GET /v1.0/{project_id}/asset/list |
Media Asset Prefetch
|
API |
Description |
|---|---|
|
POST /v1.0/{project_id}/asset/preheating |
|
|
GET /v1.0/{project_id}/asset/preheating |
Media Asset Categorization
|
API |
Description |
|---|---|
|
POST /v1.0/{project_id}/asset/category |
|
|
PUT /v1.0/{project_id}/asset/category |
|
|
DELETE /v1.0/{project_id}/asset/category |
|
|
GET /v1.0/{project_id}/asset/category |
Key Query
|
API |
Description |
|---|---|
|
GET /v1.0/{project_id}/asset/ciphers |
Statistical Analysis
|
API |
Description |
|---|---|
|
GET /v1.0/{project_id}/asset/cdn-statistics |
|
|
GET /v1.0/{project_id}/asset/vod-statistics |
|
|
GET /v1.0/{project_id}/asset/top-statistics |
|
|
GET /v1.0/{project_id}/vod/cdn/logs |
|
|
GET /v1/{project_id}/asset/daily-summary |
Watermark Template Management
|
API |
Description |
|---|---|
|
POST /v1.0/{project_id}/template/watermark |
|
|
PUT /v1.0/{project_id}/template/watermark |
|
|
GET /v1.0/{project_id}/template/watermark |
|
|
DELETE /v1.0/{project_id}/template/watermark |
|
|
POST /v1.0/{project_id}/watermark/status/uploaded |
Subtitle Management
|
API |
Description |
|---|---|
|
PUT /v1/{project_id}/asset/subtitles |
Transcoding Template Management
|
API |
Description |
|---|---|
|
POST /v2/{project_id}/asset/template/transcodings |
|
|
GET /v2/{project_id}/asset/template/transcodings |
|
|
PUT /v2/{project_id}/asset/template/transcodings |
|
|
DELETE /v2/{project_id}/asset/template/transcodings |
Transcoding Template Set Management
|
API |
Description |
|---|---|
|
POST /v1.0/{project_id}/asset/template-collection/transcodings |
|
|
PUT /v1.0/{project_id}/asset/template-collection/transcodings |
|
|
GET /v1.0/{project_id}/asset/template-collection/transcodings |
|
|
DELETE /v1.0/{project_id}/asset/template-collection/transcodings |
Transcoded Output Management
|
API |
Description |
|---|---|
|
DELETE /v1/{project_id}/asset/transcode-product |
Media Asset Storage Mode Management
|
API |
Description |
|---|---|
|
PUT /v1/{project_id}/asset/storage-mode-type |
|
|
PUT /v1/{project_id}/asset/storage-mode |
|
|
GET /v1/{project_id}/asset/storage-mode-type |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
