API overview-阿里云帮助中心

This topic lists all API operations for ApsaraVideo VOD.

Note

You can use a server-side SDK to call API operations. For information about endpoints, see VOD centers and endpoints. For information about limits, see Limits.

Media upload

API	Description
CreateUploadVideo	Get an upload URL and credential for a video and create video information.
RefreshUploadVideo	Get a new upload credential for a video after the upload times out.
CreateUploadImage	Get an upload URL and credential for an image.
CreateUploadAttachedMedia	Get an upload URL and credential for an auxiliary media asset, such as a watermark or subtitle file.
UploadMediaByURL	Pull and upload media files in batches based on their source URLs.
GetURLUploadInfos	Get information about URL-based uploads.
DeleteMultipartUpload	Immediately delete fragments generated during an upload.
GetUploadDetails	Get upload details for one or more media assets by media ID. The details include the upload time, upload progress, and upload source.
RegisterMedia	Register a media asset.

Audio and video playback

API	Description
GetPlayInfo	Get the playback URL of a media file, such as a video or audio file, by video ID.
GetVideoPlayAuth	Get the playback credential required to play a video.

Media asset management

Media asset search

API	Description
SearchMedia	Search for media assets, such as videos, audio files, images, and auxiliary media assets.

Media asset categorization

API	Description
AddCategory	Create a video category. You can create up to three levels of categories. Each category can have up to 100 subcategories.
UpdateCategory	Modify a video category.
DeleteCategory	Delete a video category. Its subcategories, including level-2 and level-3 categories, are also deleted. Use this operation with caution.
GetCategories	Get information about a specified category and its subcategories at the next level.

Audio and video management

API	Description
GetVideoInfo	Get basic information about a video by video ID. The information includes the title, description, duration, thumbnail URL, status, creation time, size, snapshots, category, and tags.
UpdateVideoInfo	Modify the information about a video.
UpdateVideoInfos	Modify the information about multiple videos at a time.
DeleteMezzanines	Delete one or more source files and their stored information in a batch.
DeleteStream	Delete one or more media streams, such as video or audio streams, and their stored files in a batch.
DeleteVideo	Delete one or more complete videos in a batch. This includes their source files, transcoded stream files, and thumbnail snapshots.
GetMezzanineInfo	Get source file information for an audio or video file. The information includes the file URL, resolution, and bitrate.
GetVideoList	Get a list of video information.
GetVideoInfos	Get information about multiple videos at a time.

Image management

API	Description
DeleteImage	Delete user-uploaded images and automatically generated video snapshots.
GetImageInfo	Get basic information about an image.
UpdateImageInfos	Modify the information about multiple images at a time.
ListSnapshots	Query snapshots of a specified media asset.

Auxiliary media asset management

API	Description
GetAttachedMediaInfo	Get basic information about one or more auxiliary media assets in a batch. The information includes the title, type, tags, and creation time.
UpdateAttachedMediaInfos	Modify the information about multiple auxiliary media assets at a time.
DeleteAttachedMedia	Delete one or more auxiliary media assets in a batch.

Animated image management

API	Description
ListDynamicImage	Query the list of animated images generated from a video.
DeleteDynamicImage	Delete animated image information.

ApsaraVideo Media Processing

Start processing

API	Description
SubmitTranscodeJobs	Submit a media transcoding job to start asynchronous transcoding.
SubmitSnapshotJob	Submit a video snapshot job to start asynchronous snapshotting. Both normal snapshots and sprites are supported.
SubmitDynamicImageJob	Submit a media animated image job to start asynchronous processing.
SubmitPreprocessJobs	Submit a video for pre-processing in the production studio.
SubmitWorkflowJob	Start a VOD workflow to process audio and video files.

Transcoding templates

API	Description
AddTranscodeTemplateGroup	Add transcoding configurations. You can create a transcoding template group or add a new transcoding template to a specified group.
UpdateTranscodeTemplateGroup	Modify transcoding configurations. You can modify a specified transcoding template within a transcoding template group.
DeleteTranscodeTemplateGroup	Delete transcoding configurations. You can delete some transcoding templates from a group or force delete the entire group.
ListTranscodeTemplateGroup	Query a list of transcoding template configurations.
SetDefaultTranscodeTemplateGroup	Set the default transcoding template configuration.
GetTranscodeTemplateGroup	Query the details of a transcoding configuration by transcoding template group ID.

Video watermarks

API	Description
AddWatermark	You can call AddWatermark to add a watermark.
UpdateWatermark	Update a watermark.
DeleteWatermark	Delete a watermark.
ListWatermark	Query a list of user watermarks.
GetWatermark	Query a single watermark.
SetDefaultWatermark	Set the default watermark.

Snapshot templates

API	Description
AddVodTemplate	Add a snapshot template.
UpdateVodTemplate	Modify a snapshot template.
DeleteVodTemplate	Delete a snapshot template.
ListVodTemplate	Query a list of snapshot templates.
GetVodTemplate	Query a single snapshot template.

Transcoding jobs

API	Description
GetTranscodeSummary	Query the transcoding summary of a video by video ID. The summary includes the transcoding status and progress. This operation returns only the latest transcoding summary because a video may be transcoded multiple times.
ListTranscodeTask	Query the historical transcoding jobs of a video by video ID. This operation does not return detailed job information.
GetTranscodeTask	Query the details of a transcoding job by transcoding job ID.

Video editing (online editing)

Editing and production

API	Description
ProduceEditingProjectVideo	Produce a finished video by combining one or more videos.

Editing project management

API	Description
AddEditingProject	Create an online editing project (video editing task).
UpdateEditingProject	Modify an online editing project (video editing task).
DeleteEditingProject	Delete one or more online editing projects in a batch.
GetEditingProject	Get the details of an online editing project (video editing task).
SearchEditingProject	Search for online editing projects (video editing list).
SetEditingProjectMaterials	Set the materials to be edited for an online editing project.
GetEditingProjectMaterials	Get the list of materials to be edited for an online editing project.

Media review

Review settings

API	Description
SetAuditSecurityIp	Set the security IP addresses for review.
ListAuditSecurityIp	Get the list of security IP addresses for review.

Manual review

API	Description
CreateAudit	Perform a manual review of media assets, such as videos and audio files.
GetAuditHistory	Get the history of manual reviews.

Automated review

API	Description
SubmitAIMediaAuditJob	Submit an automated review job. The job is executed asynchronously after submission. The operation may return a response before the job is complete.
SubmitAIImageAuditJob	Submit an automated review job for an image. The job is executed asynchronously after submission. The operation may return a response before the job is complete.
GetAIMediaAuditJob	Query an automated review job. After an AI job is submitted, it is processed asynchronously. Use this operation to query job information in real time.
GetMediaAuditResult	Get the summary of automated review results.
GetMediaAuditResultDetail	Get the details of automated review results. Use this operation to query review result details in real time.
GetMediaAuditResultTimeline	Get the timeline of all snapshots that contain prohibited content.
GetMediaAuditAudioResultDetail	Get the details of an audio review.

Video AI

Basic operations

API	Description
SubmitAIJob	Submit an AI job. The job is executed asynchronously after submission. The operation may return a response before the job is complete.
ListAIJob	Query AI jobs. After an AI job is submitted, it is processed asynchronously. Use this operation to query job information in real time.

AI templates

API	Description
AddAITemplate	Add an AI template.
DeleteAITemplate	Delete an AI template.
UpdateAITemplate	Modify an AI template.
GetAITemplate	Query an AI template.
ListAITemplate	Query a list of AI templates.
SetDefaultAITemplate	Set the default AI template.
GetDefaultAITemplate	Query the default AI template.

Media fingerprint

API	Description
GetMediaDNAResult	Get the result of a media fingerprint job. After the job is complete, use this operation to query the fingerprint result in real time.

Smart Tag

API	Description
GetMediaDNAResult	Get smart tag results.

Intelligent Thumbnail

API	Description
SubmitAIImageJob	Submit an AI image processing job.
GetAIImageJobs	Query a list of AI image jobs.
ListAIImageInfo	Query the AI image result information for a specified video.
DeleteAIImageInfos	Delete AI image information.

Live-to-VOD

API	Description
ListLiveRecordVideo	Get a list of live-to-VOD videos.

CDN for VOD

Data monitoring

API	Description
DescribeVodDomainTrafficData	Get network traffic monitoring data for accelerated domain names. Unit: byte.
DescribeVodDomainBpsData	Get network bandwidth monitoring data for accelerated domain names.

Domain name management

API	Description
AddVodDomain	Add an accelerated domain name for VOD. You can submit only one accelerated domain name at a time. A user can add a maximum of 20 domain names.
UpdateVodDomain	Modify an accelerated domain name.
DeleteVodDomain	Delete an added accelerated domain name for VOD.
BatchStartVodDomain	Enable one or more disabled accelerated domain names for VOD. The DomainStatus is changed to online.
BatchStopVodDomain	Disable one or more accelerated domain names for VOD in a batch. The DomainStatus is changed to Offline.
DescribeVodUserDomains	Query all accelerated domain names for VOD under a username.
DescribeVodDomainDetail	Get basic configuration information for a specified VOD domain name.

Domain name validation

API	Description
VerifyVodDomainOwner	Verify the ownership of a domain name.
DescribeVodVerifyContent	Get the content for ownership verification.

Domain name configuration

API	Description
BatchSetVodDomainConfigs	Configure accelerated domain names in a batch.
DescribeVodDomainConfigs	Query domain name configurations. You can query the configurations of multiple features at a time.
DeleteVodSpecificConfig	Delete the configuration of an accelerated domain name for VOD.
SetVodDomainCertificate	Enable or disable the certificate feature for a domain name and modify certificate information.
DescribeVodCertificateList	Get certificate list information.
DescribeVodDomainCertificateInfo	Get the certificate information for a specified accelerated domain name.

Refresh and prefetch

API	Description
PreloadVodObjectCaches	Prefetch content from the origin server to L2 cache nodes. This allows the first access to directly hit the cache and reduces the pressure on the origin server. This operation supports POST requests with parameters in a form.
RefreshVodObjectCaches	Refresh the file content on nodes. Refresh content on cache nodes by URL. You can refresh multiple URLs in a batch. This operation supports POST requests with parameters in a form.
DescribeVodRefreshTasks	Query whether refresh and prefetch tasks have taken effect.
DescribeVodRefreshQuota	Query the daily quota and remaining quota for refreshing or prefetching URLs and directories.

Log management

API	Description
DescribeVodDomainLog	Get the download URL for the raw CDN access logs of a specified domain name.

Data statistics

Usage data

API	Description
DescribeVodDomainUsageData	Query accelerated traffic or bandwidth usage data.
DescribeVodStorageData	Query usage data for media asset management, including storage space and outbound storage traffic.
DescribeVodTranscodeData	Query transcoding usage data.
DescribeVodAIData	Query usage data for AI processing, such as automated review and media fingerprint.

Playback data

API	Description
DescribePlayTopVideos	Get daily playback statistics for top videos, including video views (VV), unique visitors (UV), and total playback duration.
DescribePlayUserAvg	Get the average daily playback data for a specified time range.
DescribePlayUserTotal	Get the total daily playback data for a specified time range.
DescribePlayVideoStatis	Get daily playback statistics for a specified video within a specified time range.

Multi-application system

Application management

API	Description
CreateAppInfo	You can call the CreateAppInfo operation to create an application.
GetAppInfos	Query application information by application ID. You can query multiple applications at a time.
ListAppInfo	Get a list of applications that you have permission to access based on query conditions.
UpdateAppInfo	You can call UpdateAppInfo to update application information.
DeleteAppInfo	Delete application information.

Authorization management

API	Description
AttachAppPolicyToIdentity	Grant access permissions on a VOD application to a specified identity, such as a RAM user or RAM role.
ListAppPoliciesForIdentity	List the application permissions granted to a specified identity, such as a RAM user or RAM role.
DetachAppPolicyFromIdentity	Revoke specified application permissions from a specified identity, such as a RAM user or RAM role.

Resource migration

API	Description
MoveAppResource	Migrate resources, such as media assets, from one application to another.

Global settings

Event notifications

API	Description
SetMessageCallback	Set the callback method, webhook address, and event type for event notifications.
GetMessageCallback	Query the callback method, webhook address, and event type for event notifications.
DeleteMessageCallback	Delete the callback method, webhook address, and event type for event notifications.

Storage management

API	Description
SetCrossdomainContent	Update the content of the VOD cross-domain file crossdomain.xml.