API概览 - - 阿里云

本文为您介绍了点播服务的所有API列表。

说明

建议您使用服务端SDK来调用API。使用API时，接入地址请参见点播中心和访问域名，使用限制，请参见使用限制。

媒体上传

API	描述
CreateUploadVideo	调用CreateUploadVideo获取视频上传地址和凭证，并创建视频信息。
RefreshUploadVideo	调用RefreshUploadVideo用于视频文件上传超时后重新获取视频上传凭证
CreateUploadImage	调用CreateUploadImage获取图片上传地址和凭证。
CreateUploadAttachedMedia	调用CreateUploadAttachedMedia获取辅助媒资上传地址和凭证，辅助媒资包括水印、字幕文件等。
UploadMediaByURL	调用UploadMediaByURL基于源文件URL，批量拉取媒体文件进行上传。
GetURLUploadInfos	调用GetURLUploadInfos获取URL上传信息。
DeleteMultipartUpload	调用DeleteMultipartUpload立即删除上传中产生的碎片文件。
GetUploadDetails	调用GetUploadDetails通过媒资ID（支持批量）获取媒资上传详情，如上传时间、已上传比例、上传来源等信息。
RegisterMedia	调用RegisterMedia进行媒资注册。

音视频播放

API	描述
GetPlayInfo	调用GetPlayInfo通过视频ID直接获取媒体文件（支持视频和音频）的播放地址。
GetVideoPlayAuth	调用GetVideoPlayAuth获取视频播放时所需的播放凭证。

媒资管理

媒资搜索

API	描述
SearchMedia	调用SearchMedia搜索媒资信息（视频、音频、图片、辅助媒资等）。

媒资分类

API	描述
AddCategory	调用AddCategory创建视频分类。最大支持三级分类，每个分类最多支持创建100个子分类。
UpdateCategory	调用UpdateCategory修改视频分类。
DeleteCategory	调用DeleteCategory删除视频分类，同时会删除其下级分类（包括二级分类和三级分类），请慎重操作。
GetCategories	调用GetCategories获取指定的分类信息，及其子分类（即下一级分类）的列表。

音视频管理

API	描述
GetVideoInfo	调用GetVideoInfo通过视频ID获取视频的基本信息，包括：视频标题、描述、时长、封面URL、状态、创建时间、大小、截图、分类和标签等信息。
UpdateVideoInfo	调用UpdateVideoInfo修改视频信息。
UpdateVideoInfos	调用UpdateVideoInfos批量修改视频信息。
DeleteMezzanines	调用DeleteMezzanines批量删除源文件信息及存储。
DeleteStream	调用DeleteStream删除媒体流（视频流，音频流）信息及存储文件，并且支持批量删除。
DeleteVideo	调用DeleteVideo删除完整视频（包括其源文件、转码后的流文件、封面截图等），支持批量删除。
GetMezzanineInfo	调用GetMezzanineInfo获取音视频的源文件信息，包括文件地址、分辨率、码率等。
GetVideoList	调用GetVideoList获取视频信息列表。
GetVideoInfos	调用GetVideoInfos批量获取视频信息。

图片管理

API	描述
DeleteImage	调用DeleteImage删除用户上传的图片及视频自动截图。
GetImageInfo	调用GetImageInfo获取图片的基本信息。
UpdateImageInfos	调用UpdateImageInfos批量修改图片信息。
ListSnapshots	调用ListSnapshots查询指定媒体截图。

辅助媒资管理

API	描述
GetAttachedMediaInfo	调用GetAttachedMediaInfo批量获取辅助媒资的基本信息，包括标题、类型、标签、创建时间等。
UpdateAttachedMediaInfos	调用UpdateAttachedMediaInfos批量修改辅助媒资信息。
DeleteAttachedMedia	调用DeleteAttachedMedia删除辅助媒资，支持批量删除。

动图管理

API	描述
ListDynamicImage	调用ListDynamicImage查询视频截动图列表。
DeleteDynamicImage	调用DeleteDynamicImage删除动图信息。

媒体处理

发起处理

API	描述
SubmitTranscodeJobs	调用SubmitTranscodeJobs提交媒体转码作业，开始异步转码处理。
SubmitSnapshotJob	调用SubmitSnapshotJob提交视频截图作业，开始异步截图处理。支持普通截图和雪碧图截图。
SubmitDynamicImageJob	调用SubmitDynamicImageJob提交媒体动图作业，开始异步处理。
SubmitPreprocessJobs	调用SubmitPreprocessJobs提交导播台视频预处理。
SubmitWorkflowJob	调用SubmitWorkflowJob，可对音视频发起点播工作流处理。

转码模板

API	描述
AddTranscodeTemplateGroup	调用AddTranscodeTemplateGroup添加转码配置信息，可创建新的转码模板组，或者向指定模板组中添加新的转码模板。
UpdateTranscodeTemplateGroup	调用UpdateTranscodeTemplateGroup修改转码配置信息，可修改转码模板组下指定的转码模板配置。
DeleteTranscodeTemplateGroup	调用DeleteTranscodeTemplateGroup删除转码配置信息，可删除转码模板组下的部分转码模板，也可强制删除整个转码模板组。
ListTranscodeTemplateGroup	调用ListTranscodeTemplateGroup查询转码模板配置列表。
SetDefaultTranscodeTemplateGroup	调用SetDefaultTranscodeTemplateGroup设置默认转码模板配置。
GetTranscodeTemplateGroup	调用GetTranscodeTemplateGroup根据转码模板组ID查询转码配置的详细信息。

视频水印

API	描述
AddWatermark	调用AddWatermark添加水印数据。
UpdateWatermark	调用UpdateWatermark更新水印数据。
DeleteWatermark	调用DeleteWatermark删除水印。
ListWatermark	调用ListWatermark查询用户水印数据列表。
GetWatermark	调用GetWatermark查询单个水印数据。
SetDefaultWatermark	调用SetDefaultWatermark设置默认水印。

截图模板

API	描述
AddVodTemplate	调用AddVodTemplate添加截图模板。
UpdateVodTemplate	调用UpdateVodTemplate修改截图模板。
DeleteVodTemplate	调用DeleteVodTemplate删除截图模板。
ListVodTemplate	调用ListVodTemplate查询截图模板列表。
GetVodTemplate	调用GetVodTemplate查询单个截图模板。

转码任务

API	描述
GetTranscodeSummary	调用GetTranscodeSummary根据视频ID查询视频转码摘要，包括视频转码状态、转码进展等汇总信息。由于可能存在多次转码，故该接口只返回最近一次的转码摘要。
ListTranscodeTask	调用ListTranscodeTask根据视频ID查询视频历史转码任务信息，该接口不返回具体的作业信息。
GetTranscodeTask	调用GetTranscodeTask根据转码任务ID查询转码作业详细信息。

视频剪辑（云剪辑）

剪辑合成

API	描述
ProduceEditingProjectVideo	调用ProduceEditingProjectVideo将一个或多个视频合成为成品。

剪辑工程管理

API	描述
AddEditingProject	调用AddEditingProject创建云剪辑工程（视频编辑任务）。
UpdateEditingProject	调用UpdateEditingProject修改云剪辑工程（视频编辑任务）。
DeleteEditingProject	调用DeleteEditingProject删除云剪辑工程，支持批量删除。
GetEditingProject	调用GetEditingProject获取云剪辑工程（视频编辑任务）的详细信息。
SearchEditingProject	调用SearchEditingProject搜索云剪辑工程（视频编辑列表）。
SetEditingProjectMaterials	调用SetEditingProjectMaterials设置云剪辑工程的待剪辑素材。
GetEditingProjectMaterials	调用GetEditingProjectMaterials获取云剪辑工程的待剪辑素材列表。

媒体审核

审核设置

API	描述
SetAuditSecurityIp	调用SetAuditSecurityIp设置审核安全IP。
ListAuditSecurityIp	调用ListAuditSecurityIp获取审核安全IP列表。

人工审核

API	描述
CreateAudit	调用CreateAudit进行人工审核，可用于审核视频、音频等媒体信息。
GetAuditHistory	调用GetAuditHistory获取人工审核的历史记录。

直播转点播

API	描述
ListLiveRecordVideo	调用ListLiveRecordVideo获取直播转点播视频列表。

点播CDN

数据监控

API	描述
DescribeVodDomainTrafficData	调用DescribeVodDomainTrafficData获取加速域名的网络流量监控数据，单位：byte。
DescribeVodDomainBpsData	调用DescribeVodDomainBpsData获取加速域名的网络带宽监控数据。

域名管理

API	描述
AddVodDomain	调用AddVodDomain添加点播加速域名。每次只能提交一个加速域名，一个用户最多添加20个域名。
UpdateVodDomain	调用UpdateVodDomain修改加速域名。
DeleteVodDomain	调用DeleteVodDomain删除已添加的点播加速域名。
BatchStartVodDomain	调用BatchStartVodDomain启用状态为“停用”的点播加速域名，将DomainStatus变更为online。
BatchStopVodDomain	调用BatchStopVodDomain批量停用点播加速域名，将DomainStatus变更为Offline。
DescribeVodUserDomains	调用DescribeVodUserDomains查询用户名下所有的点播加速域名列表。
DescribeVodDomainDetail	调用DescribeVodDomainDetail获取指定点播域名配置的基本信息。

域名验证

API	描述
VerifyVodDomainOwner	调用VerifyVodDomainOwner校验域名归属。
DescribeVodVerifyContent	调用DescribeVodVerifyContent获取归属校验内容。

域名配置

API	描述
BatchSetVodDomainConfigs	调用BatchSetVodDomainConfigs批量配置加速域名。
DescribeVodDomainConfigs	调用DescribeVodDomainConfigs查询域名配置，一次可查询多个功能配置。
DeleteVodSpecificConfig	调用DeleteVodSpecificConfig删除点播加速域名的配置。
SetVodDomainCertificate	调用SetVodDomainCertificate设置某域名下证书功能是否启用及修改证书信息。
DescribeVodCertificateList	调用DescribeVodCertificateList获取证书列表信息。
DescribeVodDomainCertificateInfo	调用DescribeVodDomainCertificateInfo获取指定加速域名的证书信息。

刷新预热

API	描述
PreloadVodObjectCaches	调用PreloadVodObjectCaches将源站的内容主动预热到L2 Cache节点上，首次访问可直接命中缓存，缓解源站压力。支持post请求，参数用form表单。
RefreshVodObjectCaches	调用RefreshVodObjectCaches刷新节点上的文件内容。指定URL内容刷新至Cache节点，支持URL批量刷新。支持post请求，参数用form表单。
DescribeVodRefreshTasks	调用DescribeVodRefreshTasks查询刷新和预热状态是否生效。
DescribeVodRefreshQuota	调用DescribeVodRefreshQuota查询刷新预热URL及目录的最大限制数量和当日剩余数量。

日志管理

API	描述
DescribeVodDomainLog	调用DescribeVodDomainLog获取指定域名的CDN原始访问日志下载地址。

数据统计

用量数据

API	描述
DescribeVodDomainUsageData	调用DescribeVodDomainUsageData查询加速流量或带宽用量数据。
DescribeVodStorageData	调用DescribeVodStorageData查询媒资管理（存储空间、存储流出流量）的用量数据。
DescribeVodTranscodeData	调用DescribeVodTranscodeData查询转码用量数据。
DescribeVodAIData	调用DescribeVodAIData查询AI处理（智能审核、视频DNA等）的用量数据。

播放数据

API	描述
DescribePlayTopVideos	调用DescribePlayTopVideos获取每日TOP视频的播放数据统计（包括VV、UV和播放总时长）。
DescribePlayUserAvg	调用DescribePlayUserAvg获取指定时间范围内的每日播放数据均量统计。
DescribePlayUserTotal	调用DescribePlayUserTotal获取指定时间范围内的每日播放数据总量统计。
DescribePlayVideoStatis	调用DescribePlayVideoStatis获取指定视频在指定时间范围内的每日播放统计数据。

多应用体系

应用管理

API	描述
CreateAppInfo	调用CreateAppInfo创建新的应用。
GetAppInfos	调用GetAppInfos通过应用ID查询应用信息，支持批量查询。
ListAppInfo	调用ListAppInfo根据查询条件获取有权限的应用信息列表。
UpdateAppInfo	调用UpdateAppInfo更新应用信息。
DeleteAppInfo	调用DeleteAppInfo删除应用信息。

授权管理

API	描述
AttachAppPolicyToIdentity	调用AttachAppPolicyToIdentity为指定身份（RAM用户或角色）附加点播应用的访问权限。
ListAppPoliciesForIdentity	调用ListAppPoliciesForIdentity列出指定账号身份（RAM子账号或RAM角色）被授予的应用权限的列表。
DetachAppPolicyFromIdentity	调用DetachAppPolicyFromIdentity为指定账号身份（RAM子账号或RAM角色）撤销指定的应用授权。

资源迁移

API	描述
MoveAppResource	调用MoveAppResource将媒资等资源从一个应用迁移到另外一个应用。

全局配置

事件通知

API	描述
SetMessageCallback	调用SetMessageCallback设置事件通知的回调方式、回调地址、事件类型。
GetMessageCallback	调用GetMessageCallback查询事件通知的回调方式、回调地址、事件类型。
DeleteMessageCallback	调用DeleteMessageCallback删除事件通知的回调方式、回调地址、事件类型。

存储管理

API	描述
SetCrossdomainContent	调用SetCrossdomainContent更新点播跨域文件crossdomain.xml的内容。