API Overview

Updated on 2023-12-25 GMT+08:00

View PDF

The following tables list the MPC APIs. Before calling an MPC 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 an MPC API, see Application Examples.

Custom Transcoding Templates

A transcoding template is used to define transcoded video information. Before transcoding a video, you need to create a transcoding template.

API	Description
POST /v1/{project_id}/template/transcodings	Creating a Transcoding Template
DELETE /v1/{project_id}/template/transcodings{?temp_id}	Deleting a Transcoding Template
PUT /v1/{project_id}/template/transcodings	Modifying a Transcoding Template
GET /v1/{project_id}/template/transcodings{?temp_id}	Querying Transcoding Templates

Custom Transcoding Template Groups

A transcoding template group defines the output file information. A custom template group can contain a maximum of six output configurations.

API	Description
POST /v1/{project_id}/template_group/transcodings	Creating a Transcoding Template Group
GET /v1/{project_id}/template_group/transcodings{?temp_id}	Querying Transcoding Template Groups
PUT /v1/{project_id}/template_group/transcodings{?temp_id}	Updating a Transcoding Template Group
DELETE /v1/{project_id}/template_group/transcodings	Deleting a Transcoding Template Group

Watermarking

Call the watermark template APIs to deliver the watermark template and add watermarks to videos during transcoding.

API	Description
POST /v1/{project_id}/template/watermark	Creating a Watermark Template
PUT /v1/{project_id}/template/watermark	Modifying a Watermark Template
DELETE /v1/{project_id}/template/watermark{?template_id}	Deleting a Watermark Template
GET /v1/{project_id}/template/watermark{?template_id,page,size}	Querying Watermark Templates

Media Transcoding

API	Description
POST /v1/{project_id}/transcodings	Creating a Transcoding Task
DELETE /v1/{project_id}/transcodings{?task_id}	Canceling a Transcoding Task
GET /v1/{project_id}/transcodings{?task_id,start_time,end_time,status,page,size}	Querying Transcoding Tasks
DELETE /v1/{project_id}/transcodings/task	Deleting Transcoding Task Records
GET /v1/{project_id}/transcodings/summaries	Querying VOD Overview

Packaging

API	Description
POST /v1/{project_id}/remux	Creating a Packaging Task
PUT /v1/{project_id}/remux	Retrying a Packaging Task
GET /v1/{project_id}/remux{?task_id,start_time,end_time,status,page,size}	Querying Packaging Tasks
DELETE /v1/{project_id}/remux{?task_id}	Canceling a Packaging Task
DELETE /v1/{project_id}/remux/task	Deleting Packaging Task Records

GIF Converting

API	Description
POST /v1/{project_id}/animated-graphics	Creating an Animated GIF Task
GET /v1/{project_id}/animated-graphics{?task_id,start_time,end_time,status,page,size}	Querying Animated GIF Tasks
DELETE /v1/{project_id}/animated-graphics{?task_id}	Canceling an Animated GIF Task

Video Parsing

API	Description
POST /v1/{project_id}/extract-metadata	Creating a Video Parsing Task
GET /v1/{project_id}/template/extract-metadata{?task_id,start_time,end_time,status,page,size}	Querying Video Parsing Tasks
DELETE /v1/{project_id}/extract-metadata{?task_id}	Canceling a Video Parsing Task

Snapshot Capturing

API	Description
POST /v1/{project_id}/thumbnails	Creating a Snapshot Task
GET /v1/{project_id}/thumbnails{?task_id,start_time,end_time,status,page,size}	Querying Snapshot Tasks
DELETE /v1/{project_id}/thumbnails{?task_id}	Canceling a Snapshot Task

Authorization and Configuration

API	Description
PUT /v1/{project_id}/notification	Configuring Event Notifications on the Transcoding Server
GET /v1/{project_id}/notification	Querying Event Notifications on the Transcoding Server
GET /v1/{project_id}/notification/event	Querying All Events on the Transcoding Server
GET /v1/{project_id}/buckets	Querying the Bucket List
PUT /v1/{project_id}/authority	Granting or Canceling Bucket Authorization
GET /v1.0-ext/{project_id}/objects	Querying Objects in a Bucket
POST /v1/{project_id}/agencies	Requesting an OBS Authorization Task
GET /v1/{project_id}/agencies	Querying the OBS Authorization Task Status

Previous topic: Constraints

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.

Chatbot