List of operations by function - - Alibaba Cloud Documentation Center

The following tables list the API operations available for use in ApsaraVideo VOD.

Note

We recommend that you use server SDKs to call the API operations. For more information about the API endpoint, see VOD centers and endpoints. For more information about the usage limits, see Limits.

Media upload

Operation	Description
CreateUploadVideo	Obtains a URL and a credential for uploading a video and generates the video ID.
RefreshUploadVideo	Obtains a new upload credential after the video upload times out.
CreateUploadImage	Obtains a URL and a credential for uploading an image.
CreateUploadAttachedMedia	Obtains a URL and a credential for uploading an auxiliary media asset, such as a watermark file or a subtitle file.
UploadMediaByURL	Uploads multiple media files based on the URLs of mezzanine files to ApsaraVideo VOD at a time.
GetURLUploadInfos	Queries the information about URL-based upload jobs.
DeleteMultipartUpload	Immediately deletes the fragments generated during upload.
GetUploadDetails	Queries the upload details, such as the upload time, upload ratio, and upload source, about one or more media assets based on the media asset IDs.
RegisterMedia	Registers media assets.

Audio and video playback

Operation	Description
GetPlayInfo	Queries the streaming URL of a media file, such as a video or audio file, based on the video ID.
GetVideoPlayAuth	Queries the playback credential that is required for playing a video.

Media asset management

Media asset search

Operation	Description
SearchMedia	Queries the information about media assets such as videos, audio, images, and auxiliary media assets.

Media asset categories

Operation	Description
AddCategory	Creates a video category. A maximum of three category levels can be created. Each category can contain up to 100 subcategories.
UpdateCategory	Modifies a video category.
DeleteCategory	Deletes a video category. If a video category is deleted, its subcategories, including level 2 and level 3 categories, are also deleted. Exercise caution when you call this operation.
GetCategories	Queries the information about the specified category and its subcategories.

Audio and video management

Operation	Description
GetVideoInfo	Queries the basic information about a video based on the video ID. The basic information includes the title, description, duration, thumbnail URL, status, creation time, size, snapshots, category, and tags of the video.
UpdateVideoInfo	Modifies the information about a video.
UpdateVideoInfos	Modifies the information about multiple videos at a time.
DeleteMezzanines	Deletes one or more mezzanine files at a time.
DeleteStream	Deletes one or more video or audio streams and their storage files at a time.
DeleteVideo	Deletes one or more videos at a time, including their mezzanine files, transcoded stream files, and thumbnail snapshots.
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.
GetVideoList	Queries the information about videos based on query conditions.
GetVideoInfos	Queries the information about multiple videos at a time.

Image management

Operation	Description
DeleteImage	Deletes uploaded images and automatic snapshots of videos.
GetImageInfo	Queries the basic information about an image.
UpdateImageInfos	Modifies the information about one or more images at a time.
ListSnapshots	Queries the snapshots that are captured from the specified media.

Auxiliary media asset management

Operation	Description
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	Modifies the information about multiple auxiliary media assets at a time.
DeleteAttachedMedia	Deletes one or more auxiliary media assets at a time.

Animated sticker management

Operation	Description
ListDynamicImage	Queries the information about animated stickers that are captured from a video.
DeleteDynamicImage	Deletes the information about animated stickers.

Media processing

Process initiation

Operation	Description
SubmitTranscodeJobs	Submits a transcoding job and starts asynchronous transcoding.
SubmitSnapshotJob	Submits a snapshot job for a video and starts asynchronous snapshot processing. This operation supports normal snapshots and sprite snapshots.
SubmitDynamicImageJob	Submits an animated image job and starts asynchronous processing.
SubmitPreprocessJobs	Preprocesses a video by using the streaming panel.
SubmitWorkflowJob	Initiates a video-on-demand (VOD) workflow to process audio and video files.

Transcoding templates

Operation	Description
AddTranscodeTemplateGroup	Configures a transcoding template group. You can create a transcoding template group or add one or more transcoding templates to a specified transcoding template group.
UpdateTranscodeTemplateGroup	Modifies the configurations of a transcoding template group. You can modify the configurations of the specified transcoding templates in a transcoding template group.
DeleteTranscodeTemplateGroup	Deletes the configurations of a transcoding template group. You can remove one or more transcoding templates from a transcoding template group or forcibly delete the entire transcoding template group.
ListTranscodeTemplateGroup	Queries transcoding template groups.
SetDefaultTranscodeTemplateGroup	Specifies a transcoding template group as the default one.
GetTranscodeTemplateGroup	Queries the details of a transcoding template group based on the transcoding template group ID.

Video watermarks

Operation	Description
AddWatermark	Creates a watermark.
UpdateWatermark	Modifies a watermark.
DeleteWatermark	Deletes a watermark.
ListWatermark	Queries watermarks.
GetWatermark	Queries a single watermark.
SetDefaultWatermark	Specifies a watermark as the default one.

Snapshot templates

Operation	Description
AddVodTemplate	Creates a snapshot template.
UpdateVodTemplate	Modifies a snapshot template.
DeleteVodTemplate	Deletes a snapshot template.
ListVodTemplate	Queries snapshot templates.
GetVodTemplate	Queries a single snapshot template.

Transcoding tasks

Operation	Description
GetTranscodeSummary	Queries the transcoding summary of one or more videos based on the video ID. The transcoding summary includes the transcoding status and transcoding progress. A video may be transcoded multiple times. This operation returns only the latest transcoding summary.
ListTranscodeTask	Queries the historical transcoding tasks of a video based on the video ID. This operation does not return detailed job information.
GetTranscodeTask	Queries the details of transcoding jobs based on the transcoding task ID.

Online editing

Editing and production

Operation	Description
ProduceEditingProjectVideo	Produces a video from one or more mezzanine files.

Project management for online editing

Operation	Description
AddEditingProject	Creates an online editing project.
UpdateEditingProject	Modifies an online editing project.
DeleteEditingProject	Deletes one or more online editing projects.
GetEditingProject	Queries the details of an online editing project.
SearchEditingProject	Queries online editing projects.
SetEditingProjectMaterials	Sets materials to be edited for an online editing project.
GetEditingProjectMaterials	Queries materials to be edited for an online editing project.

Media review

Review settings

Operation	Description
SetAuditSecurityIp	Manages the IP addresses in review security groups.
ListAuditSecurityIp	Queries the IP addresses in a review security group.

Manual review

Operation	Description
CreateAudit	Performs manual review on media files, such as audio and video files.
GetAuditHistory	Queries the manual review history.

Live to VOD

Operation	Description
ListLiveRecordVideo	Queries live-to-VOD videos.

CDN for ApsaraVideo VOD

Data monitoring

Operation	Description
DescribeVodDomainTrafficData	Queries the network traffic for one or more specified domain names for CDN. Unit: byte.
DescribeVodDomainBpsData	Queries the bandwidth for one or more specified domain names for CDN.

Domain name management

Operation	Description
AddVodDomain	Adds a domain name for CDN to ApsaraVideo VOD. You can add only one domain name for CDN to ApsaraVideo VOD each time. You can add a maximum of 20 domain names for CDN within an Alibaba Cloud account.
UpdateVodDomain	Modifies a specified domain name for CDN.
DeleteVodDomain	Removes a domain name for CDN from ApsaraVideo VOD.
BatchStartVodDomain	Enables one or more domain names for CDN that are disabled. After a domain name for CDN is enabled, the value of the DomainStatus parameter is changed to online.
BatchStopVodDomain	Disables one or more domain names for CDN. After a domain name for CDN is disabled, the value of the DomainStatus parameter is changed to offline.
DescribeVodUserDomains	Queries the domain names for CDN within your Alibaba Cloud account.
DescribeVodDomainDetail	Queries the basic information about a specified domain name for CDN.

Domain name verification

Operation	Description
VerifyVodDomainOwner	Verifies the ownership of a specified domain name.
DescribeVodVerifyContent	Queries the ownership verification content.

Domain name configurations

Operation	Description
BatchSetVodDomainConfigs	Configures one or more domain names for CDN.
DescribeVodDomainConfigs	Queries the configurations of a specified domain name for CDN. You can query the configurations of one or more features at a time.
DeleteVodSpecificConfig	Deletes the configurations of a domain name for CDN.
SetVodDomainCertificate	Enables or disables the Secure Sockets Layer (SSL) certificate for a specified domain name for CDN. When you call this operation to enable the SSL certificate, you can also modify the certificate information.
DescribeVodCertificateList	Queries the certificates of a specified domain name for CDN or all the domain names for CDN within your Alibaba Cloud account.
DescribeVodDomainCertificateInfo	Queries the certificate information about a specific domain name for CDN.

Refresh and prefetch

Operation	Description
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. This operation supports POST requests and request parameters are in the form format.
RefreshVodObjectCaches	Refreshes files on Alibaba Cloud CDN nodes. You can refresh multiple files at a time based on URLs. This operation supports POST requests and request parameters are in the form format.
DescribeVodRefreshTasks	Queries the information about one or more refresh or prefetch tasks.
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.

Log management

Operation	Description
DescribeVodDomainLog	Queries the information about the raw access logs for a specific domain name, including the log path.

Data statistics

Resource usage

Operation	Description
DescribeVodDomainUsageData	Queries the traffic or bandwidth data for one or more domain names for CDN.
DescribeVodStorageData	Queries the statistics of media asset management, including the storage statistics and outbound traffic for storage.
DescribeVodTranscodeData	Queries the statistics on transcoding of different specifications.
DescribeVodAIData	Queries the statistics on video AI of different types, such as automated review and media fingerprinting.

Playback statistics

Operation	Description
DescribePlayTopVideos	Queries the playback statistics of daily top videos. The playback statistics includes the video views, unique visitors, and total playback duration.
DescribePlayUserAvg	Queries the statistics on average playback each day in a specified time range.
DescribePlayUserTotal	Queries the statistics on total playback each day in a specified time range.
DescribePlayVideoStatis	Queries daily playback statistics on a video in a specified time range.

Multi-application service

Application management

Operation	Description
CreateAppInfo	Creates an application.
GetAppInfos	Queries the information about one or more applications based on application IDs.
ListAppInfo	Queries the applications that you are authorized to manage based on query conditions.
UpdateAppInfo	Updates the information about an application.
DeleteAppInfo	Deletes an application.

Authorization management

Operation	Description
AttachAppPolicyToIdentity	Grants the permissions on an application of ApsaraVideo VOD to a specified RAM user or RAM role.
ListAppPoliciesForIdentity	Queries the permissions that are granted to a specified RAM user or RAM role on an application of ApsaraVideo VOD.
DetachAppPolicyFromIdentity	Revokes the permissions on an application of ApsaraVideo VOD from a specified RAM user or RAM role.

Resource migration

Operation	Description
MoveAppResource	Migrates one or more resources from an application to another application.

Global configurations

Event notifications

Operation	Description
SetMessageCallback	Sets the callback method, callback URL, and event type of an event notification.
GetMessageCallback	Queries the callback method, callback URL, and event type of an event notification.
DeleteMessageCallback	Deletes the callback method, callback URL, and event type of an event notification.

Storage management

Operation	Description
SetCrossdomainContent	Updates the cross-domain policy file crossdomain.xml.