Help Center/ Video On Demand/ API Reference/ API Overview

Updated on 2023-11-13 GMT+08:00

View PDF

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 Upload APIs

API	Description
POST /v1.0/{project_id}/asset	Uploading Media Files to VOD
GET /v1.1/{project_id}/asset/authority	Obtaining Upload Authorization
POST /v1.0/{project_id}/asset/status/uploaded	Confirming Media Upload
PUT /v1.0/{project_id}/asset/authority	Authorizing Access to OBS
POST /v1.0/{project_id}/asset/reproduction	Replicating Media Files from OBS to VOD
POST /v1.0/{project_id}/asset/obs/host/stock/task	Replicating Media Files from OBS to VOD
POST /v1.0/{project_id}/asset/upload_by_url	Pulling Media Files from URLs
GET /v1.0/{project_id}/asset/duplication	Verifying the Upload

Media Processing APIs

API	Description
PUT /v1.0/{project_id}/asset	Updating a Media File
POST /v1.0/{project_id}/asset/process	Processing a Media File
DELETE /v1.0/{project_id}/asset/process	Canceling a Transcoding Task
POST /v1.0/{project_id}/asset/extract_audio	Extracting Audio
DELETE /v1.0/{project_id}/asset/extract_audio	Canceling an Audio Extraction Task
PUT /v1.0/{project_id}/asset/cover	Setting a Thumbnail

Media Management APIs

API	Description
DELETE /v1.0/{project_id}/asset	Deleting Media Files
POST /v1.0/{project_id}/asset/status/publish	Publishing Media Files
POST /v1.0/{project_id}/asset/status/unpublish	Canceling Media Publish
GET /v1.0/{project_id}/asset/info	Querying File Information
PUT /v1.0/{project_id}/asset/info	Modifying File Attributes
GET /v1.0/{project_id}/asset/details	Querying File Details
GET /v1.0/{project_id}/asset/list	Querying Media Files

OBS Hosting Management APIs

API	Description
GET /v1.0/{project_id}/asset/obs/host/stock/task	Querying Hosting Tasks
GET /v1.0/{project_id}/asset/obs/host/stock/task/details	Querying Details About a Hosting Task
GET /v1.0/{project_id}/asset/obs/host/task/details	Querying Details About Hosted Media Files

Media Pre-loading APIs

API	Description
POST /v1.0/{project_id}/asset/preheating	Pre-loading Media
GET /v1.0/{project_id}/asset/preheating	Querying Pre-loading Results

Media Category APIs

API	Description
POST /v1.0/{project_id}/asset/category	Creating a Media Category
PUT /v1.0/{project_id}/asset/category	Modifying a Media Category
DELETE /v1.0/{project_id}/asset/category	Deleting a Media Category
GET /v1.0/{project_id}/asset/category	Querying Media Categories

Key Query API

API	Description
GET /v1.0/{project_id}/asset/ciphers	Key Query API

Statistics Analysis APIs

API	Description
GET /v1.0/{project_id}/asset/cdn-statistics	Querying CDN Statistics
GET /v1.0/{project_id}/asset/vod-statistics	Querying Origin Server Statistics
GET /v1.0/{project_id}/asset/top-statistics	Querying Most Requested Content
GET /v1.0/{project_id}/vod/cdn/logs	Querying Playback Logs of a Domain Name

Watermark Template Management APIs

API	Description
POST /v1.0/{project_id}/template/watermark	Creating a Watermark Template
PUT /v1.0/{project_id}/template/watermark	Modifying a Watermark Template
GET /v1.0/{project_id}/template/watermark	Querying Watermark Templates
DELETE /v1.0/{project_id}/template/watermark	Deleting a Watermark Template
POST /v1.0/{project_id}/watermark/status/uploaded	Confirming Watermark Image Upload

Subtitle Management

API	Description
PUT /v1/{project_id}/asset/subtitles	Managing Subtitles

Transcoding Template Management APIs

API	Description
POST /v2/{project_id}/asset/template/transcodings	Creating a Custom Transcoding Template
GET /v2/{project_id}/asset/template/transcodings	Querying Transcoding Templates
PUT /v2/{project_id}/asset/template/transcodings	Modifying a Transcoding Template
DELETE /v2/{project_id}/asset/template/transcodings	Deleting a Custom Transcoding Template

Transcoding Template Set Management APIs

API	Description
POST /v1.0/{project_id}/asset/template-collection/transcodings	Creating a Transcoding Template Group Set
PUT /v1.0/{project_id}/asset/template-collection/transcodings	Modifying a Transcoding Template Group Set
GET /v1.0/{project_id}/asset/template-collection/transcodings	Querying Custom Template Group Sets
DELETE /v1.0/{project_id}/asset/template-collection/transcodings	Deleting a Transcoding Template Group Set

Previous topic: Concepts

Next topic: Calling APIs

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.