API standards and multilingual preset SDKs
The OpenAPI of this product (Mts/2014-06-18) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Media information
|
API |
Title |
Description |
| QueryMediaInfoJobList | Query media information analysis jobs | Queries media information analysis jobs. |
Transcoding
|
API |
Title |
Description |
| SubmitJobs | Submit a transcoding job | Submits a transcoding job. When transcoding jobs and workflows created in the console cannot meet your scenarios, you can invoke the SubmitJobs operation to transcode media files as needed. Configure the required transcoding parameters based on your business logic. |
| CancelJob | CancelJob | Cancels a transcoding job. |
| QueryJobList | Query transcoding jobs | Queries transcoding jobs in batches by job IDs. |
| ListJob | List transcoding jobs | Lists transcoding jobs. |
Preset intelligent template recommendation
|
API |
Title |
Description |
| SubmitAnalysisJob | Submit a preset template analysis job | Submits a preset template analysis job. |
| QueryAnalysisJobList | Query template analysis jobs | Queries template analysis jobs and returns a list of available preset templates after the template analysis jobs are completed. |
Custom transcoding template
|
API |
Title |
Description |
| QueryTemplateList | QueryTemplateList | You can call this operation to query up to 10 transcoding templates at a time. |
| SearchTemplate | SearchTemplate | You can call this operation to query custom transcoding templates in the specified state. |
Watermark template
|
API |
Title |
Description |
| AddWaterMarkTemplate | AddWaterMarkTemplate | Creates a watermark template. |
| DeleteWaterMarkTemplate | DeleteWaterMarkTemplate | Deletes a watermark template. |
| UpdateWaterMarkTemplate | UpdateWaterMarkTemplate | Updates the name and configurations of the specified watermark template. |
| SearchWaterMarkTemplate | SearchWaterMarkTemplate | Searches for watermark templates. |
| QueryWaterMarkTemplateList | QueryWaterMarkTemplateList | Queries watermark templates. |
Snapshot
|
API |
Title |
Description |
| QuerySnapshotJobList | Query snapshot job results | Queries snapshot jobs. |
MPS queue
|
API |
Title |
Description |
| QueryPipelineList | QueryPipelineList | Query pipelines by pipeline ID. |
| SearchPipeline | Search pipelines | Search for pipelines by status. |
| AddPipeline | AddPipeline | Adds an ApsaraVideo Media Processing (MPS) queue. |
Media workflow
|
API |
Title |
Description |
| AddMediaWorkflow | Create a media workflow | Creates a media workflow. |
| ActivateMediaWorkflow | Activate a media workflow | Activates a media workflow. |
| DeactivateMediaWorkflow | Deactivate a media workflow | Deactivates a media workflow. |
| DeleteMediaWorkflow | Delete a media workflow | Deletes a media workflow. |
| UpdateMediaWorkflow | Update the topology of a media workflow | Updates a media workflow. |
| QueryMediaWorkflowList | QueryMediaWorkflowList | Queries registered media workflows. |
| SearchMediaWorkflow | SearchMediaWorkflow | Queries media workflows in the specified state. |
| UpdateMediaWorkflowTriggerMode | Update the trigger mode of a media workflow | Updates the trigger mode of a media workflow. |
Media workflow execution instance
|
API |
Title |
Description |
| QueryMediaWorkflowExecutionList | QueryMediaWorkflowExecutionList | Queries media workflow execution instances. |
| ListMediaWorkflowExecutions | List media workflow execution instances | Lists media workflow execution instances. |
Media bucket
|
API |
Title |
Description |
| BindInputBucket | BindInputBucket | Binds an input media bucket. |
| BindOutputBucket | BindOutputBucket | Binds an output media bucket. Media buckets are Object Storage Service (OSS) buckets that are used by ApsaraVideo Media Processing (MPS) to store media resources. After you bind an OSS bucket to MPS as an input media bucket or output media bucket, MPS has the permissions to listen to the messages of the bucket, which indicate that files are uploaded to the bucket. This way, MPS can trigger workflows and return files that are processed. You can all this operation to bind an output media bucket to the media library. |
| UnbindInputBucket | UnbindInputBucket | Unbinds an input media bucket from the media library. |
| UnbindOutputBucket | UnbindOutputBucket | Detaches an output media bucket. |
| ListAllMediaBucket | ListAllMediaBucket | Queries all media buckets bound to the media library. |
Media
|
API |
Title |
Description |
| AddMedia | Add media | Submits a job to add media. |
| DeleteMedia | DeleteMedia | Deletes media files from ApsaraVideo Media Processing (MPS). |
| UpdateMedia | Update the basic information of a media file | Updates the basic information of a media file. |
| UpdateMediaCategory | UpdateMediaCategory | Updates the category to which a media file belongs. |
| UpdateMediaCover | UpdateMediaCover | Updates the thumbnail of a media file. |
| AddMediaTag | AddMediaTag | Adds a tag to a media file. |
| DeleteMediaTag | DeleteMediaTag | Removes a tag for a media file. |
| UpdateMediaPublishState | UpdateMediaPublishState | Updates the publishing status of a media file. |
| QueryMediaList | Query media list | You can call this operation to query media files by media ID. |
| QueryMediaListByURL | Query media information by input URL | Queries media by using OSS file URLs. |
Video DNA
|
API |
Title |
Description |
| SubmitFpShotJob | Submit a media fingerprint job | Queries whether identical or similar media fingerprint (DNA) results exist in a media fingerprint library. |
| QueryFpShotJobList | Query DNA job results | Queries the results of DNA jobs. This operation supports querying the results of all types of DNA jobs. |
| CreateFpShotDB | Create a media fingerprint library | Submits a job to create a media fingerprint library. |
| ListFpShotDB | Query DNA libraries | Queries DNA libraries. |
| SubmitFpFileDeleteJob | Submit a DNA file deletion job | Submits a job to delete DNA files. |
| QueryFpFileDeleteJobList | Query DNA file deletion jobs | Queries DNA file deletion jobs. |
| SubmitFpDBDeleteJob | Submit a DNA library deletion job | Submits a job to delete a DNA library. |
| QueryFpDBDeleteJobList | Query DNA library deletion jobs | Queries DNA library deletion jobs. |
Others
|
API |
Title |
Description |
| AddTemplate | Create a custom transcoding template | Creates a custom template that includes container information, video stream settings, and audio stream settings. |
| DeletePipeline | DeletePipeline | Deletes an ApsaraVideo Media Processing (MPS) queue. |
| DeleteTemplate | DeleteTemplate | Deletes a custom transcoding template. |
| QueryCopyrightExtractJob | Query a copyright watermark extraction job | Invoke this API to query a job for fetching copyright watermark information. |
| QueryCopyrightJob | Query video copyright watermark jobs | Queries video copyright watermark jobs. |
| QueryIProductionJob | Query an intelligent production job | Queries an intelligent production job. |
| QueryMediaCensorJobDetail | Query content moderation job details | Queries the details of a content moderation job. |
| QueryMediaCensorJobList | List content moderation jobs | Queries a list of content moderation jobs. |
| QueryTraceAbJob | Query video tracing watermark AB stream job | Invoke this API to query video tracing watermark AB stream jobs. |
| QueryTraceExtractJob | Query tracing watermark fetch job | Invoke this API to query the tracing watermark fetch job information. |
| QueryTraceM3u8Job | Query video tracing watermark M3U8 jobs | Queries video tracing watermark M3U8 jobs. |
| SubmitCopyrightExtractJob | Submit a Copyright Watermark Extraction Job | Submits a copyright watermark extraction job. |
| SubmitCopyrightJob | Submit Video Copyright Watermarking Job | Use SubmitCopyrightJob to submit a video copyright watermark job. |
| SubmitIProductionJob | Submit an intelligent production job | Submits an intelligent production job. |
| SubmitMediaCensorJob | Submit a content moderation job | Submits a content moderation job. |
| SubmitMediaInfoJob | Submit a media information analysis job | Submits a media information analysis job. After this operation is called, ApsaraVideo Media Processing (MPS) analyzes the input file and returns its media information. |
| SubmitSnapshotJob | Submit a snapshot job | Submits a snapshot job. After you call this operation, ApsaraVideo Media Processing takes snapshots and generates image sprites for the input file. |
| SubmitTraceAbJob | Submit Video Tracing Watermark AB Stream Job | The SubmitTraceAbJob operation submits a video tracing watermark A/B stream job. |
| SubmitTraceExtractJob | Submit a Tracing Watermark Extraction Job | Submits a trace watermark extraction job. |
| SubmitTraceM3u8Job | Submit Video Tracing Watermark M3U8 Job | Submits a job to generate an M3U8 file with a video tracing watermark. |
| UpdatePipeline | Update pipeline: name, status, and notification settings | Update an MPS queue. |
| UpdateTemplate | Update custom transcoding template | Update custom transcoding template settings. |