ApsaraVideo for Media Processing (MPS) lets you manage cloud resources by calling its API. It also provides scenario-specific SDKs to simplify client-side integration.
OpenAPI
Alibaba Cloud provides the OpenAPI Portal to help you learn and use cloud product APIs quickly and efficiently. The portal combines intelligent search, documentation, online debugging, SDK downloads, code samples, and tools for error diagnosis and usage statistics. You can use the OpenAPI Portal to call APIs for various Alibaba Cloud products and view the requests and responses. The portal also automatically generates SDK code examples to help you get started quickly. For more information, see What is OpenAPI.
Versioning
Alibaba Cloud uses version numbers to manage API sets for major product releases. For example, MPS currently supports the API version labeled 2014-06-18. This string 2014-06-18 is a version identifier, not a date. It represents the latest public API data and does not mean the API has remained static since 2014-06-18.
|
API version |
Description |
|
Recommended |
Online debugging
MPS provides API debugging features in the OpenAPI Portal. Before you call an API, you need to understand the service's supported versions, service endpoints, and integration methods. In the Alibaba Cloud OpenAPI Portal, you can debug the SubmitMediaInfoJob API. Select a service endpoint, such as China (Shanghai), and fill in the request parameters: Input (the job input, a required string), UserData (custom user data, optional), PipelineId (the pipeline ID, optional), and Async (whether to submit an asynchronous job, an optional Boolean). Then, click Initiate Call. This API is limited to 50 QPS.
API explorer
You can debug this API at: https://next.api.aliyun.com/api/Mts/2014-06-18
Service endpoints
To minimize latency, choose the service endpoint in the same region as your resources.
MPS is deployed in multiple regions. You can use a regional domain name in the format mts.{regionId}.aliyuncs.com.
For faster response times, you can also use a VPC domain name in the format mts-vpc.{regionId}.aliyuncs.com.
For more information about service endpoints, see Service endpoints.
Supported identities
This product supports API calls from the following user identities. We recommend using a RAM user or RAM role and granting permissions as needed before calling an API.
When you log in to the OpenAPI Portal, it uses your Alibaba Cloud Account by default for online debugging. An Alibaba Cloud Account has full access to all APIs, which poses a high security risk. We strongly recommend that you create and use a RAM user for API access or daily O&M. Before calling an API, grant permissions to the RAM user as needed. The RAM user must have the required permissions to perform operations. For more information, see Permission management.
|
User identity |
Support |
|
Supported |
|
|
RAM user (Recommended) |
Supported |
|
RAM role (Recommended) |
Supported |
More information
Integration methods
Using an Alibaba Cloud SDK is the easiest and best-supported method for calling the API.
Integration methods at a glance
|
Invocation method |
Support |
|
Alibaba Cloud SDK (Recommended) |
Supported |
|
Supported |
|
|
Not supported |
|
|
Not supported |
|
|
Supported |
Alibaba Cloud SDK
MPS provides Alibaba Cloud SDKs for several popular programming languages. You can use these SDKs to call the MPS API to transcode video and add watermarks without complex programming. For more information, see the SDK reference.
Alibaba Cloud CLI
The Alibaba Cloud CLI is a command-line tool that lets you interact with Alibaba Cloud services and manage your cloud resources by using the aliyun command in a terminal. For more information, see What is Alibaba Cloud CLI.
Terraform
Terraform is an open source tool that allows you to preview, configure, and manage your cloud infrastructure and resources safely and efficiently. Its operating mechanism is similar to Alibaba Cloud's Resource Orchestration Service (ROS), where it converts a template into internal data to make API calls. For more information, see About Alibaba Cloud Terraform.
Resource Orchestration Service (ROS)
Resource Orchestration Service (ROS) is an Alibaba Cloud service that simplifies the management of cloud resources. You can write templates to define your required Alibaba Cloud resources, such as ECS instances and RDS database instances, and their dependencies. The ROS orchestration engine then automatically creates and configures all the resources based on your template, automating deployment and O&M. For more information, see What is Resource Orchestration Service.
Custom encapsulated API call
If none of the methods above meet your business needs, you can build your own requests to call the API, though this is not recommended. This approach requires you to implement the signature algorithm, construct custom requests, and make HTTP calls yourself. For more information about the signature mechanism, see V3 request body & signature mechanism.
Usage notes
-
If an MPS API call fails, use the returned error code to check your request parameters and values. For more information, see the Error code center.
-
You can also record the RequestID from the API response or the error message from the SDK and use the Alibaba Cloud OpenAPI Diagnostic Platform for self-service diagnostics.