ApsaraVideo VOD exposes OpenAPIs for media asset management and control. You can call these APIs by using Alibaba Cloud SDK, Alibaba Cloud CLI, or Infrastructure as Code (IaC) tools.
ApsaraVideo VOD OpenAPI
ApsaraVideo VOD provides OpenAPIs that cover the entire media lifecycle, including upload, management, processing, distribution, and playback. Integrate these APIs into your application to manage cloud resources programmatically. If you are unfamiliar with OpenAPI and its principles, see What is OpenAPI.
OpenAPI version guide
Alibaba Cloud uses version numbers to manage operation lists across major API versions of each cloud service.
For example, ApsaraVideo VOD currently supports the 2017-03-21 API version. 2017-03-21 is a version identifier rather than a date, and it always reflects the latest public API operations.
|
API version number |
Description |
|
Recommended |
Online debugging
You can debug ApsaraVideo VOD API operations directly in the OpenAPI portal. Before calling an API, familiarize yourself with the API version, endpoint, and integration method.
API debugging entry: https://next.api.alibabacloud.com/api/vod/2017-03-21/
Endpoint description
Select an endpoint based on the region where your resource resides to reduce latency.
ApsaraVideo VOD deploys management and control services across multiple regions. Use region-specific domain names in the format vod.{regionId}.aliyuncs.com.
For lower latency, you can also use VPC domain names in the format vod-vpc.{regionId}.aliyuncs.com.
For more information about endpoints, see Service endpoints.
Supported identities
The following identities are supported. We recommend that you use a RAM user or RAM role and grant only the required permissions before calling API operations.
When you log on to the OpenAPI portal with your Alibaba Cloud account, the portal uses your current identity for debugging by default. We strongly recommend that you use a RAM user for API calls and routine O&M. Grant the RAM user only the permissions required by your business. For more information, see Use RAM for access control.
|
Identity |
Support |
|
Supported |
|
|
RAM user (recommended) |
Supported |
|
RAM role (recommended) |
Supported |
More information
Supported calling methods
You can use one of the following methods to call the ApsaraVideo VOD API.
Alibaba Cloud SDK (recommended)
Alibaba Cloud SDK is the recommended and best-supported way to call OpenAPI operations. ApsaraVideo VOD provides SDKs in multiple programming languages that let you implement features such as video playback, watermarking, clipping, and live-to-VOD without complex programming. For more information, see Server SDK.
Alibaba Cloud CLI
Alibaba Cloud CLI lets you manage cloud resources from a command line terminal by using the aliyun command. For more information, see What is Alibaba Cloud CLI.
Custom API call encapsulation
If the preceding methods do not meet your requirements, you can construct HTTP requests manually. This requires implementing the signature algorithm and building custom request headers. For more information, see V3 request body & signature mechanism.
Notes
-
If an error is returned after you call the ApsaraVideo VOD API, check whether the request parameters are valid based on the error code. For more information, see Common error codes.
-
You can also record the RequestID returned by the call or the SDK error message, and use the Alibaba Cloud OpenAPI diagnostic platform for self-diagnosis.