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 |
| SubmitMediaInfoJob | SubmitMediaInfoJob | Submits a media information analysis job. After you call this operation, ApsaraVideo Media Processing (MPS) analyzes the media information of the input file and returns the results. |
| QueryMediaInfoJobList | QueryMediaInfoJobList | Queries media information analysis jobs. |
Transcoding
|
API |
Title |
Description |
| QueryJobList | Query Transcoding Jobs | Batch query transcoding jobs by transcoding job IDs. |
Preset intelligent template recommendation
|
API |
Title |
Description |
| UpdateTemplate | Update custom transcoding template | Update custom transcoding template settings. |
Custom transcoding template
|
API |
Title |
Description |
| SubmitSnapshotJob | Submit a snapshot job | Submit a screenshot job. Media Processing Service (MPS) will then take screenshots and generate a sprite image from the input file. |
| QuerySnapshotJobList | Query snapshot job results | Queries snapshot jobs. |
Watermark template
|
API |
Title |
Description |
| UpdatePipeline | Update pipeline: name, status, and notification settings | Update an MPS queue. |
| QueryPipelineList | QueryPipelineList | Query pipelines by pipeline ID. |
| SearchPipeline | Search pipelines | Search for pipelines by status. |
Snapshot
|
API |
Title |
Description |
| UpdateMediaWorkflow | Update the topology of a media workflow | Update a media workflow. |
MPS queue
|
API |
Title |
Description |
| UnbindOutputBucket | UnbindOutputBucket | Detaches an output media bucket. |
Media workflow
|
API |
Title |
Description |
| QueryMediaList | Query media list | You can call this operation to query media files by media ID. |
| QueryMediaListByURL | Query media information by media input URL | Queries media files by their Object Storage Service (OSS) file URLs. |
Media workflow execution instance
|
API |
Title |
Description |
| QueryIProductionJob | Query an intelligent production job | Query an intelligent production job. |
| SubmitIProductionJob | Submit Intelligent Production Job | Submits an intelligent production job. |
Media bucket
|
API |
Title |
Description |
Media
|
API |
Title |
Description |
| QueryMediaCensorJobDetail | Query content moderation job details | Query the details of a content moderation job. |
| QueryMediaCensorJobList | Query the list of content moderation jobs | Queries a list of content moderation jobs. |
Intelligent production
|
API |
Title |
Description |
| CreateFpShotDB | CreateFpShotDB | Submits a job to create a media fingerprint library. |
| ListFpShotDB | ListFpShotDB | Query DNA databases. |
| SubmitFpDBDeleteJob | SubmitFpDBDeleteJob | Submits a job to delete or purge a DNA library. |
| QueryFpDBDeleteJobList | QueryFpDBDeleteJobList | Queries the status of one or more jobs submitted to clear or delete a media fingerprint library (FpDB). |
Intelligent tagging
|
API |
Title |
Description |
| SubmitCopyrightJob | Submit Video Copyright Watermarking Job | Use SubmitCopyrightJob to submit a video copyright watermark job. |
| QueryCopyrightJob | Query video copyright watermark jobs | Invoke this API to query video copyright watermarking jobs. |
| SubmitTraceAbJob | Submit Video Tracing Watermark AB Stream Job | The SubmitTraceAbJob operation submits a video tracing watermark A/B stream job. |
| QueryTraceAbJob | Query video tracing watermark AB stream job | Invoke this API to query video tracing watermark AB stream jobs. |
| SubmitTraceM3u8Job | Submit Video Tracing Watermark M3U8 Job | Submits a job to generate an M3U8 file with a video tracing watermark. |
| QueryTraceM3u8Job | Query video tracing watermark m3u8 job | Invoke this API to query the video tracing watermark m3u8 job. |
| SubmitCopyrightExtractJob | Submit a Copyright Watermark Extraction Job | Submits a copyright watermark extraction job. |
| QueryCopyrightExtractJob | Query a copyright watermark extraction job | Invoke this API to query a job for fetching copyright watermark information. |
| SubmitTraceExtractJob | Submit a Tracing Watermark Extraction Job | Submits a trace watermark extraction job. |
| QueryTraceExtractJob | Query tracing watermark fetch job | Invoke this API to query the tracing watermark fetch job information. |
Content moderation
|
API |
Title |
Description |
| ActivateMediaWorkflow | ActivateMediaWorkflow | Activates a media workflow. |
| AddMedia | AddMedia | Creates a new media job. |
| AddMediaTag | AddMediaTag | Adds a tag to a media file. |
| AddMediaWorkflow | AddMediaWorkflow | Creates a media workflow. |
| AddPipeline | AddPipeline | Adds an ApsaraVideo Media Processing (MPS) queue. |
| AddTemplate | AddTemplate | Creates a custom transcoding template. You need to configure the information such as the container format, video stream settings, and audio stream settings. |
| AddWaterMarkTemplate | AddWaterMarkTemplate | Creates a watermark template. |
| 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. |
| CancelJob | CancelJob | Cancels a transcoding job. |
| DeactivateMediaWorkflow | DeactivateMediaWorkflow | Disables a media workflow. |
| DeleteMedia | DeleteMedia | Deletes media files from ApsaraVideo Media Processing (MPS). |
| DeleteMediaTag | DeleteMediaTag | Removes a tag for a media file. |
| DeleteMediaWorkflow | DeleteMediaWorkflow | Deletes a media workflow. This does not affect workflow instances that are running. |
| DeletePipeline | DeletePipeline | Deletes an ApsaraVideo Media Processing (MPS) queue. |
| DeleteTemplate | DeleteTemplate | Deletes a custom transcoding template. |
| DeleteWaterMarkTemplate | DeleteWaterMarkTemplate | Deletes a watermark template. |
| ListAllMediaBucket | ListAllMediaBucket | Queries all media buckets bound to the media library. |
| ListJob | ListJob | Traverses transcoding jobs |
| ListMediaWorkflowExecutions | ListMediaWorkflowExecutions | Queries the execution instances of a media workflow. |
| QueryAnalysisJobList | QueryAnalysisJobList | Queries the template analysis job and returns a list of available preset templates when the template analysis job is complete. |
| QueryFpFileDeleteJobList | QueryFpFileDeleteJobList | Queries the jobs of deleting media files from a media fingerprint library. |
| QueryFpShotJobList | QueryFpShotJobList | Retrieves the results of all types of DNA jobs. |
| QueryMediaWorkflowExecutionList | QueryMediaWorkflowExecutionList | Queries media workflow execution instances. |
| QueryMediaWorkflowList | QueryMediaWorkflowList | Queries registered media workflows. |
| QueryTemplateList | QueryTemplateList | You can call this operation to query up to 10 transcoding templates at a time. |
| QueryWaterMarkTemplateList | QueryWaterMarkTemplateList | Queries watermark templates. |
| SearchMediaWorkflow | SearchMediaWorkflow | Queries media workflows in the specified state. |
| SearchTemplate | SearchTemplate | You can call this operation to query custom transcoding templates in the specified state. |
| SearchWaterMarkTemplate | SearchWaterMarkTemplate | Searches for watermark templates. |
| SubmitAnalysisJob | SubmitAnalysisJob | Submits a preset template analysis job. |
| SubmitFpFileDeleteJob | SubmitFpFileDeleteJob | Submits a job of deleting media files from a media fingerprint library. |
| SubmitFpShotJob | SubmitFpShotJob | This operation searches a DNA library for matching or similar fingerprints. |
| SubmitJobs | SubmitJobs | This operation submits a transcoding job. You can use this operation if the transcoding tasks or workflows created in the console do not meet your requirements. You can configure the required transcoding parameters based on your business logic. |
| SubmitMediaCensorJob | SubmitMediaCensorJob | Submits a media censor job. |
| UnbindInputBucket | UnbindInputBucket | Unbinds an input media bucket from the media library. |
| UpdateMedia | UpdateMedia | Updates the basic information about a media file. |
| UpdateMediaCategory | UpdateMediaCategory | Updates the category to which a media file belongs. |
| UpdateMediaCover | UpdateMediaCover | Updates the thumbnail of a media file. |
| UpdateMediaPublishState | UpdateMediaPublishState | Updates the publishing status of a media file. |
| UpdateMediaWorkflowTriggerMode | UpdateMediaWorkflowTriggerMode | Updates the trigger mode of a media workflow. |
| UpdateWaterMarkTemplate | UpdateWaterMarkTemplate | Updates the name and configurations of the specified watermark template. |