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

Updated on 2024-12-04 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 Asset Upload

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

Media Asset Processing

API	Description
PUT /v1.0/{project_id}/asset	Updating a Video
POST /v1.0/{project_id}/asset/process	Processing a Media Asset
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 Asset Management

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

Media Asset Prefetch

API	Description
POST /v1.0/{project_id}/asset/preheating	Prefetching Media Assets on CDN
GET /v1.0/{project_id}/asset/preheating	Querying CDN Prefetch Results

Media Asset Categorization

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

Key Query

API	Description
GET /v1.0/{project_id}/asset/ciphers	Querying Keys

Statistical Analysis

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
GET /v1/{project_id}/asset/daily-summary	Querying Daily Playback Statistics of a Media Asset

Watermark Template Management

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

API	Description
POST /v2/{project_id}/asset/template/transcodings	Customizing a 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 Transcoding Template

Transcoding Template Set Management

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 Transcoding Template Group Sets
DELETE /v1.0/{project_id}/asset/template-collection/transcodings	Deleting a Transcoding Template Group Set

Transcoded Output Management

API	Description
DELETE /v1/{project_id}/asset/transcode-product	Deleting a Transcoded Output

Media Asset Storage Mode Management

API	Description
PUT /v1/{project_id}/asset/storage-mode-type	Modifying the Cold Storage Scope of a Media Asset
PUT /v1/{project_id}/asset/storage-mode	Changing the OBS Storage Class of a Media Asset
GET /v1/{project_id}/asset/storage-mode-type	Querying the Cold Storage Settings of a Media Asset

Previous topic: Before You Start

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.