API overview

更新时间:
复制 MD 格式

API standard and pre-built SDKs in multi-language

The OpenAPI specification of this product (Mts/2014-06-18) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.

Custom signature

If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).

Before you begin

An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.

Media information analysis

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.

Custom transcoding template management

API

Title

Description

UpdateTemplate Update custom transcoding template Update custom transcoding template settings.

Video snapshot job management

API

Title

Description

SubmitSnapshotJob Submit a snapshot job Submit a snapshot job. After you invoke this API, ApsaraVideo Media Processing (MPS) performs snapshot capture and image stitching on the input file.
QuerySnapshotJobList Query snapshot job results Queries snapshot jobs.

MPS queue management

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.

Media workflow management

API

Title

Description

UpdateMediaWorkflow Update the topology of a media workflow Update a media workflow.

Media bucket management

API

Title

Description

UnbindOutputBucket UnbindOutputBucket Detaches an output media bucket.

Media management

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.

Intelligent production

API

Title

Description

QueryIProductionJob Query an intelligent production job Query an intelligent production job.
SubmitIProductionJob Submit Intelligent Production Job Submit an intelligent production job.

Smart Label Interface

API

Title

Description

SubmitSmarttagJob Submit a DataQ - Smart Tag Service Job Submits a smart tagging job.
QuerySmarttagJob Query Smart Tag Job Queries a DataQ - Smart Tag Service job.
AddSmarttagTemplate Add Template Add an analysis template for a DataQ - Smart Tag Service job.
UpdateSmarttagTemplate Update Template Updates the analysis template for a smart tag job.
RegisterCustomFace RegisterCustomFace Register a custom face.
TagCustomPerson Add labels to a custom person library or a person Add labels to a custom person library or a person.
CreateCustomGroup Create a custom library Create a custom library.
CreateCustomEntity Create a custom entity Create a custom entity in the corresponding custom library.
RegisterCustomView Register a custom entity image Register a custom entity image.
DeleteCustomEntity Delete a custom library entity Delete a custom library entity.
DeleteCustomView Delete a custom entity image Delete a custom entity image.
ListCustomViews Obtain a list of images for different views of a Custom library entity Retrieves a list of images for different views of an entity in a custom library.
ListCustomEntities Obtain the list of entities under a custom library Obtain the list of entities under a custom library.
ListCustomGroups Retrieve the list of custom libraries Retrieve the list of custom libraries.

Media review

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.

Media fingerprint analysis

API

Title

Description

ListFpShotDB ListFpShotDB Query DNA databases.

digital watermark interface

API

Title

Description

SubmitCopyrightJob Submit Video Copyright Watermarking Job Invoke SubmitCopyrightJob to submit a video copyright watermarking job.
QueryCopyrightJob Query video copyright watermark jobs Invoke this API to query video copyright watermarking jobs.
SubmitTraceAbJob Submit Video Tracing Watermark AB Stream Job You can submit a video tracing watermark AB stream job by invoking the SubmitTraceAbJob API.
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 Invoke this API to submit a video tracing watermark M3U8 job.
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 Invoke this API to submit 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 Invoke this API to submit a tracing watermark extraction job.
QueryTraceExtractJob Query tracing watermark fetch job Invoke this API to query the tracing watermark fetch job information.
SubmitImageCopyright Submit Transparent Image Watermark Invoke this API to submit a request for generating a transparent image watermark.

Others

API

Title

Description

ActivateMediaWorkflow ActivateMediaWorkflow Activates a media workflow.
AddMedia AddMedia Adds a media file.
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.
CreateFpShotDB CreateFpShotDB Submits a job of creating a media fingerprint library.
DeactivateMediaWorkflow DeactivateMediaWorkflow Disables a media workflow.
DeleteCustomGroup DeleteCustomGroup Delete a custom image library.
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.
DeleteSmarttagTemplate DeleteSmarttagTemplate Deletes a template.
DeleteTemplate DeleteTemplate Deletes a custom transcoding template.
DeleteWaterMarkTemplate DeleteWaterMarkTemplate Deletes a watermark template.
ImAudit ImAudit Reviews images and text and returns the review results.
ImportFpShotJob ImportFpShotJob Submits a job of importing text files to a text fingerprint library.
ListAllMediaBucket ListAllMediaBucket Queries all media buckets bound to the media library.
ListCustomPersons ListCustomPersons Queries the information about all figures and faces in a specific figure library.
ListFpShotFiles ListFpShotFiles Queries media files in a media fingerprint library.
ListFpShotImportJob ListFpShotImportJob Queries jobs of importing text files to a text fingerprint 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.
QueryFpDBDeleteJobList QueryFpDBDeleteJobList Queries the jobs of clearing or deleting a media fingerprint library.
QueryFpFileDeleteJobList QueryFpFileDeleteJobList Queries the jobs of deleting media files from a media fingerprint library.
QueryFpShotJobList QueryFpShotJobList Queries media fingerprint analysis jobs. You can call this operation to query video fingerprint analysis jobs and text fingerprint analysis jobs.
QueryJobList QueryJobList You can query multiple transcoding jobs by their IDs.
QueryMediaWorkflowExecutionList QueryMediaWorkflowExecutionList Queries media workflow execution instances.
QueryMediaWorkflowList QueryMediaWorkflowList Queries registered media workflows.
QuerySmarttagTemplateList QuerySmarttagTemplateList Queries the analysis template of a smart tagging job.
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.
SubmitFpDBDeleteJob SubmitFpDBDeleteJob Submits a job of clearing or deleting a media fingerprint library.
SubmitFpFileDeleteJob SubmitFpFileDeleteJob Submits a job of deleting media files from a media fingerprint library.
SubmitFpShotJob SubmitFpShotJob Submits a media fingerprint analysis job to query the media fingerprint repository for a media file with the identical or similar fingerprint as the input file.
SubmitJobs SubmitJobs Submits transcoding jobs. If the transcoding jobs and workflows created in the ApsaraVideo Media Processing (MPS) console cannot meet your business requirements, you can call the SubmitJobs operation to submit transcoding jobs. Specify transcoding parameters as required when you call the SubmitJobs operation.
SubmitMediaCensorJob SubmitMediaCensorJob Submits a content moderation job.
UnbindInputBucket UnbindInputBucket Unbinds an input media bucket from the media library.
UnregisterCustomFace UnregisterCustomFace Deletes a custom face, all the custom faces that are registered in a custom figure library, or a custom figure 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.