This product(
vod/2017-03-21) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (11370001915) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Media upload
| API | Title | Description |
|---|---|---|
| CreateUploadVideo | CreateUploadVideo | Obtains the upload URLs and credentials for media files and creates media assets in ApsaraVideo VOD. |
| RefreshUploadVideo | RefreshUploadVideo | Obtains a new upload credential after a file failed to be uploaded. |
| CreateUploadImage | CreateUploadImage | Queries a URL and a credential for uploading an image. |
| CreateUploadAttachedMedia | CreateUploadAttachedMedia | Obtains a URL and a credential for uploading an auxiliary media asset, such as a watermark, subtitle, or material. |
| UploadMediaByURL | UploadMediaByURL | Uploads media files based on URLs. |
| GetURLUploadInfos | GetURLUploadInfos | Queries the information about URL-based upload jobs. |
| CancelUrlUploadJobs | CancelUrlUploadJobs | Cancels URL-based upload jobs in the queue. |
| UploadStreamByURL | UploadStreamByURL | Uploads transcoded streams to ApsaraVideo VOD from external storage. |
| DeleteMultipartUpload | DeleteMultipartUpload | Deletes the parts generated during an upload. |
| GetUploadDetails | GetUploadDetails | Queries the upload details, such as the upload time, upload ratio, and upload source, about one or more media files based on the media IDs. |
| RegisterMedia | RegisterMedia | Registers media files. After you add an Object Storage Service (OSS) bucket to ApsaraVideo VOD, you must register the media files in the bucket to generate the required information before you use features such as transcoding and snapshot capture on the media files. |
Audio and video playback
| API | Title | Description |
|---|---|---|
| GetPlayInfo | GetPlayInfo | Queries the playback URL of a video or audio file by its ID. |
| GetVideoPlayAuth | GetVideoPlayAuth | Queries the credential required for media playback. |
Media asset management
| API | Title | Description |
|---|---|---|
| Media asset search | Media asset search | |
| SearchMedia | SearchMedia | Queries information about videos, audio, images, and auxiliary media assets. You can call this operation and specify the search protocol to query media assets based on the return fields, fields used for exact match, fields used for fuzzy match, fields used for a multi-value query, fields used for a range query, and sort fields. |
| Tiered storage | Tiered storage | |
| UpdateMediaStorageClass | UpdateMediaStorageClass | Modifies the storage classes of media assets. |
| RestoreMedia | RestoreMedia | Restores media assets. |
| Media asset category | Media asset category | |
| AddCategory | AddCategory | Creates a video category. |
| UpdateCategory | UpdateCategory | Modifies a video category. |
| DeleteCategory | DeleteCategory | Deletes a video category. |
| GetCategories | GetCategories | Queries the information about the specified category and its subcategories. |
| Audio and video management | Audio and video management | |
| GetVideoInfo | GetVideoInfo | Obtains information about multiple audio or video files. |
| GetVideoInfos | GetVideoInfos | Obtains information about multiple audio or video files. |
| GetVideoList | GetVideoList | Queries information about media files. |
| GetMezzanineInfo | GetMezzanineInfo | Queries the information about the mezzanine file of an audio or video. The information includes the mezzanine file URL, resolution, and bitrate of the audio or video. |
| UpdateVideoInfo | UpdateVideoInfo | Modifies the information about a video. |
| UpdateVideoInfos | UpdateVideoInfos | Modifies the information about multiple videos at a time. |
| DeleteMezzanines | DeleteMezzanines | Deletes one or more source files at a time. |
| DeleteStream | DeleteStream | Deletes one or more video or audio streams and their storage files at a time. |
| DeleteVideo | DeleteVideo | Deletes one or more videos at a time, including their mezzanine files, transcoded stream files, and thumbnail snapshots. |
| Auxiliary media asset management | Auxiliary media asset management | |
| GetAttachedMediaInfo | GetAttachedMediaInfo | Queries the basic information about one or more auxiliary media assets. The basic information includes the title, type, tags, and creation time of an auxiliary media asset. |
| UpdateAttachedMediaInfos | UpdateAttachedMediaInfos | Modifies the information about multiple auxiliary media assets at a time. |
| DeleteAttachedMedia | DeleteAttachedMedia | Deletes one or more auxiliary media assets at a time. |
| Image management | Image management | |
| GetImageInfo | GetImageInfo | Queries the basic information about an image based on the image ID. The basic information includes the title, type, creation time, and tags of the image. |
| GetImageInfos | GetImageInfos | Queries the basic information about multiple images at a time. |
| UpdateImageInfos | UpdateImageInfos | Modifies the information about one or more images at a time. |
| ListSnapshots | ListSnapshots | Queries the snapshots that are captured from the specified media. |
| DeleteImage | DeleteImage | Deletes uploaded images and video snapshots that are automatically captured. |
| Animated sticker management | Animated sticker management | |
| ListDynamicImage | ListDynamicImage | Queries the information about animated stickers of a video based on the video ID. |
| DeleteDynamicImage | DeleteDynamicImage | Deletes the information about animated stickers. |
Media processing
| API | Title | Description |
|---|---|---|
| Process initiation | Process initiation | |
| SubmitTranscodeJobs | SubmitTranscodeJobs | Submits a transcoding job to start transcoding in an asynchronous manner. |
| SubmitSnapshotJob | SubmitSnapshotJob | Submits a snapshot job for a video and starts asynchronous snapshot processing. |
| SubmitPreprocessJobs | SubmitPreprocessJobs | Preprocesses a video by using the production studio. |
| SubmitDynamicImageJob | SubmitDynamicImageJob | Submits a frame animation job and starts asynchronous processing. |
| SubmitWorkflowJob | SubmitWorkflowJob | Initiates a workflow to process media files. |
| Transcoding template | Transcoding template | |
| AddTranscodeTemplateGroup | AddTranscodeTemplateGroup | Creates a transcoding template group or adds transcoding templates to a transcoding template group. |
| UpdateTranscodeTemplateGroup | UpdateTranscodeTemplateGroup | Modifies the configurations of a transcoding template group or configurations of transcoding templates in the transcoding template group. |
| SetDefaultTranscodeTemplateGroup | SetDefaultTranscodeTemplateGroup | Specifies a transcoding template group as the default one. |
| ListTranscodeTemplateGroup | ListTranscodeTemplateGroup | Queries transcoding template groups. |
| GetTranscodeTemplateGroup | GetTranscodeTemplateGroup | Queries the details of a transcoding template group based on the template group ID. |
| DeleteTranscodeTemplateGroup | DeleteTranscodeTemplateGroup | Deletes one or more transcoding templates from a transcoding template group or forcibly deletes a transcoding template group. |
| Snapshot template | Snapshot template | |
| AddVodTemplate | AddVodTemplate | Adds a snapshot template or frame animation template. |
| UpdateVodTemplate | UpdateVodTemplate | Modifies a snapshot template. |
| GetVodTemplate | GetVodTemplate | Queries a single snapshot template. |
| ListVodTemplate | ListVodTemplate | Queries snapshot templates. |
| DeleteVodTemplate | DeleteVodTemplate | Deletes a snapshot template. |
| Video watermark | Video watermark | |
| AddWatermark | AddWatermark | Adds a watermark. |
| UpdateWatermark | UpdateWatermark | Modifies a watermark. |
| DeleteWatermark | DeleteWatermark | Deletes a watermark. |
| SetDefaultWatermark | SetDefaultWatermark | Sets a watermark as the default one. |
| GetWatermark | GetWatermark | Queries information about an watermark. |
| ListWatermark | ListWatermark | Queries watermarks. |
| Transcoding task | Transcoding task | |
| GetTranscodeSummary | GetTranscodeSummary | Queries transcoding summaries of audio and video files based on the file ID. A transcoding summary includes the status and progress of transcoding. |
| ListTranscodeTask | ListTranscodeTask | Queries transcoding tasks based on the media ID. This operation does not return specific job information. |
| GetTranscodeTask | GetTranscodeTask | Queries details about transcoding jobs based on the transcoding task ID. |
Online editing
| API | Title | Description |
|---|---|---|
| ProduceEditingProjectVideo | ProduceEditingProjectVideo | Produces a video from one or more source files. You can directly specify source files by configuring the Timeline parameter. Alternatively, you can specify source files after you create an online editing project. |
| Project management for online editing | Project management for online editing | |
| AddEditingProject | AddEditingProject | Creates an online editing project. |
| UpdateEditingProject | UpdateEditingProject | Modifies an online editing project. |
| DeleteEditingProject | DeleteEditingProject | Deletes online editing projects. |
| SetEditingProjectMaterials | SetEditingProjectMaterials | Sets materials to be edited for an online editing project. |
| GetEditingProject | GetEditingProject | Queries the details of an online editing project. |
| GetEditingProjectMaterials | GetEditingProjectMaterials | Queries materials to be edited for an online editing project. |
| SearchEditingProject | SearchEditingProject | Queries online editing projects. |
Media review
| API | Title | Description |
|---|---|---|
| Review settings | Review settings | |
| SetAuditSecurityIp | SetAuditSecurityIp | Manages the IP addresses in review security groups. |
| ListAuditSecurityIp | ListAuditSecurityIp | Queries the IP addresses in a review security group. |
| Automated review | Automated review | |
| SubmitAIMediaAuditJob | SubmitAIMediaAuditJob | Submits an automated review job for a media file. After the job is submitted, ApsaraVideo VOD asynchronously processes the job. Therefore, the operation may return a response before the job is complete. |
| SubmitAIImageAuditJob | SubmitAIImageAuditJob | Submits an automated review job for an image. After the job is submitted, the job is processed in an asynchronous manner. The operation may return a response before the job is complete. |
| GetAIMediaAuditJob | GetAIMediaAuditJob | Queries the information about an intelligent review job. After the job is submitted, it is processed asynchronously. You can call this operation to query the job information in real time. |
| GetMediaAuditResult | GetMediaAuditResult | Queries the summary of automated review results. |
| GetMediaAuditResultDetail | GetMediaAuditResultDetail | Queries the details of automated review results. You can call this operation to query the details of review results in real time. |
| GetMediaAuditResultTimeline | GetMediaAuditResultTimeline | Queries the timelines of all snapshots that violate content regulations. |
| GetMediaAuditAudioResultDetail | GetMediaAuditAudioResultDetail | Queries the details of audio review results. |
| Manual review | Manual review | |
| CreateAudit | CreateAudit | Performs manual review on media files, such as audio and video files. |
| GetAuditHistory | GetAuditHistory | Queries the manual review history. |
Video AI
| API | Title | Description |
|---|---|---|
| AI templates | AI templates | |
| AddAITemplate | AddAITemplate | Adds an AI template for automated review and smart thumbnail tasks. |
| DeleteAITemplate | DeleteAITemplate | Deletes an AI template. |
| UpdateAITemplate | UpdateAITemplate | Modifies an AI template. |
| SetDefaultAITemplate | SetDefaultAITemplate | Specifies an AI template as the default template. |
| GetAITemplate | GetAITemplate | Queries the details of an AI template. |
| ListAITemplate | ListAITemplate | Queries AI templates. |
| GetDefaultAITemplate | GetDefaultAITemplate | Queries information about the default AI template. |
| AI jobs | AI jobs | |
| ListAIJob | ListAIJob | Queries AI jobs. After a job is submitted, ApsaraVideo VOD asynchronously processes the job. You can call this operation to query the job information in real time. |
| SubmitAIJob | SubmitAIJob | Submits a smart tagging or video fingerprinting job. |
| Video DNA | Video DNA | |
| GetMediaDNAResult | GetMediaDNAResult | Queries a media fingerprinting result. After a media fingerprinting job is complete, you can call this operation to query the media fingerprinting result. |
| SubmitMediaDNADeleteJob | SubmitMediaDNADeleteJob | Deletes a video fingerprinting job. |
| Smart tagging | Smart tagging | |
| GetAIVideoTagResult | GetAIVideoTagResult | Queries the results of smart tagging jobs. |
| Smart thumbnail | Smart thumbnail | |
| SubmitAIImageJob | SubmitAIImageJob | Submits jobs of image AI processing. |
| GetAIImageJobs | GetAIImageJobs | Queries jobs of image AI processing. |
| ListAIImageInfo | ListAIImageInfo | Queries the AI processing results about the images of a specified video. |
| DeleteAIImageInfos | DeleteAIImageInfos | Deletes the information about one or more images that are submitted for AI processing. |
Live to VOD
| API | Title | Description |
|---|---|---|
| ListLiveRecordVideo | ListLiveRecordVideo | Queries live-to-VOD videos. |
CDN for ApsaraVideo VOD
| API | Title | Description |
|---|---|---|
| Data monitoring | Data monitoring | |
| Request statistics | Request statistics | |
| DescribeVodDomainTrafficData | DescribeVodDomainTrafficData | Queries the network traffic for one or more accelerated domain names. |
| DescribeVodDomainBpsData | DescribeVodDomainBpsData | Queries the bandwidth for one or more specified domain names for CDN. |
| Back-to-origin statistics | Back-to-origin statistics | |
| DescribeVodDomainSrcTrafficData | DescribeVodDomainSrcTrafficData | Queries origin traffic data for accelerated domain names in ApsaraVideo VOD. The traffic is measured in bytes. |
| DescribeVodDomainSrcBpsData | DescribeVodDomainSrcBpsData | Queries origin bandwidth data for accelerated domain names in ApsaraVideo VOD. The bandwidth is measured in bit/s. |
| Domain name management | Domain name management | |
| AddVodDomain | AddVodDomain | Adds a domain name to accelerate in ApsaraVideo VOD. |
| DeleteVodDomain | DeleteVodDomain | Removes a domain name for CDN from ApsaraVideo VOD. |
| UpdateVodDomain | UpdateVodDomain | Modifies a specific accelerated domain name. |
| DescribeVodUserDomains | DescribeVodUserDomains | Queries the domain names for CDN within your Alibaba Cloud account. |
| DescribeVodDomainDetail | DescribeVodDomainDetail | Queries the basic information about a specified domain name for CDN. |
| BatchStartVodDomain | BatchStartVodDomain | Enables accelerated domain names that are in the disabled state. |
| BatchStopVodDomain | BatchStopVodDomain | Disables accelerated domain names. |
| Domain name verification | Domain name verification | |
| VerifyVodDomainOwner | VerifyVodDomainOwner | Verifies the ownership of a specified domain name. |
| DescribeVodVerifyContent | DescribeVodVerifyContent | Queries the ownership verification content. |
| Domain name configurations | Domain name configurations | |
| DeleteVodSpecificConfig | DeleteVodSpecificConfig | Deletes the configurations of a domain name for CDN. |
| SetVodDomainCertificate | SetVodDomainCertificate | Enables or disables the certificate of a domain name and modifies the certificate information. |
| DescribeVodDomainConfigs | DescribeVodDomainConfigs | Queries the configurations of a domain name for CDN. You can query the configurations of multiple features at a time. |
| DescribeVodCertificateList | DescribeVodCertificateList | Queries the certificates of a specified domain name for CDN or all the domain names for CDN within your Alibaba Cloud account. |
| DescribeVodDomainCertificateInfo | DescribeVodDomainCertificateInfo | Queries the certificate information about an accelerated domain name. |
| BatchSetVodDomainConfigs | BatchSetVodDomainConfigs | Configures one or more domain names for CDN. |
| Refresh and prefetch | Refresh and prefetch | |
| DescribeVodRefreshTasks | DescribeVodRefreshTasks | Queries the information about one or more refresh or prefetch tasks. |
| DescribeVodRefreshQuota | DescribeVodRefreshQuota | Queries the maximum number and remaining number of requests to refresh or prefetch files on the current day. You can prefetch files based on URLs and refresh files based on URLs or directories. |
| PreloadVodObjectCaches | PreloadVodObjectCaches | Prefetches resources from an origin server to L2 nodes. Users can directly hit the cache upon their first visits. This way, workloads on the origin server can be reduced. |
| RefreshVodObjectCaches | RefreshVodObjectCaches | Refreshes files on Alibaba Cloud CDN nodes. You can refresh multiple files at a time based on URLs. |
| RefreshMediaPlayUrls | RefreshMediaPlayUrls | Submits media refresh or prefetch tasks based on the media IDs. |
| GetMediaRefreshJobs | GetMediaRefreshJobs | Queries the information about media refresh or prefetch jobs, such as the job status and filtering conditions. |
| Log management | Log management | |
| DescribeVodDomainLog | DescribeVodDomainLog | Queries the information about the CDN access logs for a domain name, including the log path. |
Video security
| API | Title | Description |
|---|---|---|
| HLS encryption | HLS encryption | |
| GenerateKMSDataKey | GenerateKMSDataKey | Generates a random Key Management Service (KMS) data key used for HLS encryption in ApsaraVideo VOD. |
| DecryptKMSDataKey | DecryptKMSDataKey | Decrypts the ciphertext specified by CiphertextBlob in the Key Management Service (KMS) data key. |
| Digital watermark | Digital watermark | |
| SubmitDigitalWatermarkExtractJob | SubmitDigitalWatermarkExtractJob | Submits a digital watermark extraction job. Digital watermarks are extracted in an asynchronous mode. |
| GetDigitalWatermarkExtractResult | GetDigitalWatermarkExtractResult | Queries the result of a digital watermark extraction job. |
| Secure download and caching | Secure download and caching | |
| GenerateDownloadSecretKey | GenerateDownloadSecretKey | Generates a key for secure download. ApsaraVideo Player SDK provides the secure download feature. Videos that are downloaded to your local device in this mode are encrypted. You can play the encrypted videos only by using the key file generated from the app that you specified. Secure download protects your videos from malicious playback or distribution. |
Data statistics
| API | Title | Description |
|---|---|---|
| Resource usage | Resource usage | |
| DescribeVodDomainUsageData | DescribeVodDomainUsageData | Queries the traffic or bandwidth data of one or more accelerated domain names. |
| DescribeVodStorageData | DescribeVodStorageData | Queries the usage of storage-related resources, including the storage volume and outbound traffic. |
| DescribeVodTranscodeData | DescribeVodTranscodeData | Queries the transcoding statistics. |
| DescribeVodAIData | DescribeVodAIData | Queries the statistics on video AI of different types, such as automated review and media fingerprinting. |
| Playback statistics | Playback statistics | |
| DescribePlayTopVideos | DescribePlayTopVideos | Queries daily playback statistics on top videos, including video views, unique visitors, and total playback duration. |
| DescribePlayUserAvg | DescribePlayUserAvg | Queries the statistics on average playback each day in a specified time range. |
| DescribePlayUserTotal | DescribePlayUserTotal | Queries the daily playback statistics in a specified time range. |
| DescribePlayVideoStatis | DescribePlayVideoStatis | Queries daily playback statistics on a video in the specified time range. |
Multi-application service
| API | Title | Description |
|---|---|---|
| Application management | Application management | |
| CreateAppInfo | CreateAppInfo | Creates an application. |
| DeleteAppInfo | DeleteAppInfo | Deletes an application. |
| UpdateAppInfo | UpdateAppInfo | Updates the information about an application. |
| GetAppInfos | GetAppInfos | Queries the information about one or more applications based on application IDs. |
| ListAppInfo | ListAppInfo | Queries the applications that you are authorized to manage based on query conditions. |
| AddVodStorageForApp | AddVodStorageForApp | Binds a storage bucket to one or more applications in ApsaraVideo VOD. |
| Authorization management | Authorization management | |
| AttachAppPolicyToIdentity | AttachAppPolicyToIdentity | Grants a RAM user or RAM role permissions to access ApsaraVideo VOD applications. |
| DetachAppPolicyFromIdentity | DetachAppPolicyFromIdentity | Revokes application permissions from the specified identity. The identity may be a RAM user or RAM role. |
| ListAppPoliciesForIdentity | ListAppPoliciesForIdentity | Queries the application policies that are attached to the specified identity. The identity may be a RAM user or RAM role. |
| Resource migration | Resource migration | |
| MoveAppResource | MoveAppResource | Migrates resources between applications. The application administrator can directly migrate resources between applications. Resource Access Management (RAM) users or RAM roles must obtain the write permissions on the source and destination applications before they migrate resources between applications. Multiple resources can be migrated at a time. |
Global configurations
| API | Title | Description |
|---|---|---|
| Storage management | Storage management | |
| SetCrossdomainContent | SetCrossdomainContent | Updates the cross-domain policy file crossdomain.xml. |
| Event notifications | Event notifications | |
| DeleteMessageCallback | DeleteMessageCallback | Deletes the callback method, callback URL, and event type of an event notification. |
| SetMessageCallback | SetMessageCallback | Sets the callback method, callback URL, and event type of an event notification. |
| GetMessageCallback | GetMessageCallback | Queries the callback method, callback URL, and event type for event notifications. |