All Products
Search
Document Center

API overview

Last Updated: Aug 01, 2019

Media import

OperationDescriptionSDK example
CreateUploadVideoObtains the upload address and credential for a video or audio.Java,Python,PHP,and . NET(C#)
RefreshUploadVideoRefreshes the upload credential for a video or audio.Java,Python,PHP,and . NET(C#)
CreateUploadImageObtains the upload address and credential for an image.Java,Python,PHP,and . NET(C#)
CreateUploadAttachedMediaObtains the upload address and credential for an attached media asset such as a watermark or subtitle file.Java,Python,PHP,and . NET(C#)
UploadMediaByURLUploads multiple media files based on the source file URLs.Java,Python,PHP,and . NET(C#)
RegisterMediaRegisters media objects in OSS as media assets.Java,Python,PHP,and . NET(C#)

After obtaining the upload address and credential from ApsaraVideo for VOD for a media file, you can call OSS upload operations to upload the file.

Audio and video playback

Operation Description
GetPlayInfo Obtains the video or audio playback address.
GetVideoPlayAuth Obtains the video or audio playback credential.

Media asset management

Operation Description
SearchMedia Searches for media asset information.
GetVideoInfo Obtains video information.
UpdateVideoInfo Modifies video information.
DeleteVideo Deletes one or more videos.
GetVideoList Obtains a video information list.
GetMezzanineInfo Obtains the source file URL of a video.
DeleteMezzanines Deletes multiple source files.
DeleteStream Deletes one or more media streams.
GetVideoInfos Obtains the information about multiple videos.
UpdateVideoInfos Modifies the information about multiple videos.
DeleteImage Deletes one or more images.
GetImageInfo Obtains image information.
UpdateImageInfos Updates the information about multiple images.

Live to VOD

Operation Description
ListLiveRecordVideo Obtains a list of VOD files created from live streams.

Media processing

Operation Description
SubmitTranscodeJobs Submits a media transcoding job and starts asynchronous transcoding.
SubmitSnapshotJob Submits a video snapshot job and starts asynchronous screenshot.
ListSnapshots Queries snapshot data.

Video watermark

Operation Description
AddWatermark Adds a watermark.
UpdateWatermark Modifies a watermark.
DeleteWatermark Deletes a watermark.
ListWatermark Queries a list of watermarks.
GetWatermark Queries a watermark.
SetDefaultWatermark Sets the default watermark.

After obtaining the upload address and credential for a watermark file, you can call OSS upload operations to upload the file.

Snapshot template

Operation Description
AddVodTemplate Adds a snapshot template.
UpdateVodTemplate Modifies a snapshot template.
DeleteVodTemplate Deletes a snapshot template.
ListVodTemplate Queries a list of snapshot templates.
GetVodTemplate Queries a snapshot template.

Content moderation

Operation Description
SetAuditSecurityIp Adds IP addresses to review security groups.
ListAuditSecurityIp Obtains a whitelist of IP addresses that have been added to review security groups.
CreateAudit Starts a manual review.
GetAuditHistory Obtains the manual review history.

Video editing (online editing)

Operation Description
ProduceEditingProjectVideo Merges videos.
AddEditingProject Creates an online editing project.
UpdateEditingProject Modifies an online editing project.
DeleteEditingProject Deletes one or more online editing projects.
GetEditingProject Obtains the information about an online editing project.
SearchEditingProject Searches for online editing projects.
SetEditingProjectMaterials Sets materials to be edited for an online editing project.
GetEditingProjectMaterials Obtains a list of materials to be edited for an online editing project.

Video category

Operation Description
AddCategory Creates a video category.
UpdateCategory Modifies a video category.
DeleteCategory Deletes a video category.
GetCategories Obtains the specified category information and a list of its subcategories.

CDN acceleration

Operation Description
PushObjectCache Preloads content to cache nodes.
RefreshObjectCaches Refreshes the cached content on nodes.
DescribeRefreshTasks Queries the status of refresh and preload tasks.
DescribeRefreshQuota Queries the maximum number and remaining number of requests to refresh and preload content on the current day.
DescribeCdnDomainLogs Downloads raw CDN access logs for a specified domain name.
DescribeDomainFlowData Obtains the network traffic monitoring data for CDN domain names.
DescribeDomainBpsData Obtains the network bandwidth monitoring data for CDN domain names.

Data statistics

Operation Description
DescribePlayUserTotal Obtains the total daily playback statistics for videos in a specified time range.
DescribePlayUserAvg Obtains the average daily playback statistics for videos in a specified time range.
DescribePlayTopVideos Obtains daily playback statistics for top videos.
DescribePlayVideoStatis Obtains daily playback statistics for a video in a specified time range.