API概览

本产品(视频点播/2017-03-21)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

媒体上传

API标题API概述
CreateUploadVideo获取音视频上传地址和凭证获取音视频上传地址和凭证,并创建音视频信息。
RefreshUploadVideo刷新视频上传凭证调用RefreshUploadVideo用于视频文件上传超时后重新获取视频上传凭证。
CreateUploadImage获取图片上传地址和凭证获取图片上传地址和凭证。
CreateUploadAttachedMedia获取辅助媒资上传地址和凭证获取辅助媒资上传地址和凭证,辅助媒资包括水印、字幕、素材等。
UploadMediaByURLURL拉取上传基于源文件URL,拉取音视频媒体文件进行上传,支持批量上传。
GetURLUploadInfos获取URL上传信息获取URL上传信息。
CancelUrlUploadJobs取消URL上传任务取消排队中的URL上传任务。
UploadStreamByURL通过URL上传转码流上传外部存储的转码流文件并挂载到对应的点播媒资下。
DeleteMultipartUpload删除上传中的碎片文件删除上传中产生的碎片文件。
GetUploadDetails获取媒体上传详情通过媒体ID获取媒体上传详情(如上传时间、已上传比例、上传来源等信息),支持批量获取。
RegisterMedia注册媒资信息进行媒资注册。

音视频播放

API标题API概述
GetPlayInfo获取音视频播放地址通过音视频ID直接获取媒体文件(支持视频和音频)的播放地址。
GetVideoPlayAuth获取音视频播放凭证获取音视频播放时所需的播放凭证。

媒资管理

API标题API概述
媒资搜索媒资搜索
SearchMedia搜索媒体信息搜索媒资信息,包括视频、音频、图片、辅助媒资等。
媒资分类媒资分类
AddCategory创建分类调用AddCategory创建媒资分类。
UpdateCategory更新分类修改媒资分类。
DeleteCategory删除分类删除媒资分类。
GetCategories获取分类及子分类获取指定的分类信息,及其子分类(即下一级分类)的列表。
音视频管理音视频管理
GetVideoInfo获取单个音视频信息获取单个音视频的基本信息。
GetVideoInfos批量获取音视频信息批量获取音视频信息。
GetVideoList获取音视频信息列表获取视频信息列表。
GetMezzanineInfo获取源文件信息获取音视频的源文件信息,包括文件地址、分辨率、码率等。
UpdateVideoInfo修改单个音视频信息修改单个音视频信息。
UpdateVideoInfos批量修改音视频信息批量修改音视频信息。
DeleteMezzanines批量删除音视频源文件批量删除音视频源文件信息。
DeleteStream删除媒体流删除媒体流(视频流,音频流)信息及存储文件。
DeleteVideo删除完整视频删除完整视频(包括视频源文件、转码后的流文件、封面截图等)。
辅助媒资管理辅助媒资管理
GetAttachedMediaInfo获取辅助媒资信息调用GetAttachedMediaInfo获取辅助媒资的基本信息,包括标题、类型、标签、创建时间等。
UpdateAttachedMediaInfos更新辅助媒资信息调用UpdateAttachedMediaInfos批量修改辅助媒资信息。
DeleteAttachedMedia删除辅助媒资删除辅助媒资,支持批量删除。
图片管理图片管理
GetImageInfo获取图片信息调用GetImageInfo通过图片ID获取图片的基本信息及访问地址。
GetImageInfos批量获取图片信息 调用GetImageInfos接口批量获取图片的基本信息及访问地址。
UpdateImageInfos批量更新图片信息调用UpdateImageInfos批量修改图片信息。
ListSnapshots查询截图数据调用ListSnapshots查询指定媒体截图。
DeleteImage删除图片调用DeleteImage删除用户上传的图片及视频自动截图。
动图管理动图管理
ListDynamicImage查询动图列表调用ListDynamicImage,通过视频ID查询视频截动图列表。
DeleteDynamicImage删除动图信息调用DeleteDynamicImage删除动图信息。

媒体处理

API标题API概述
发起处理发起处理
SubmitTranscodeJobs提交媒体转码作业调用SubmitTranscodeJobs提交媒体转码作业,开始异步转码处理。
SubmitSnapshotJob提交媒体截图作业调用SubmitSnapshotJob提交视频截图作业,开始异步截图处理。
SubmitPreprocessJobs导播台视频预处理调用SubmitPreprocessJobs,通过导播台对视频进行转码处理。
SubmitDynamicImageJob提交媒体动图作业调用SubmitDynamicImageJob提交媒体动图作业,开始异步处理。
SubmitWorkflowJob提交点播工作流作业调用SubmitWorkflowJob对视频发起点播工作流处理。
转码模板转码模板
AddTranscodeTemplateGroup创建转码模板组调用AddTranscodeTemplateGroup添加转码配置信息,可创建新的转码模板组,或者向指定模板组中添加新的转码模板。
UpdateTranscodeTemplateGroup修改转码配置调用UpdateTranscodeTemplateGroup修改转码配置信息,可修改转码模板组下指定的转码模板配置。
SetDefaultTranscodeTemplateGroup设置默认转码配置调用SetDefaultTranscodeTemplateGroup设置默认转码模板配置。
ListTranscodeTemplateGroup查询转码配置列表调用ListTranscodeTemplateGroup查询转码模板配置列表。
GetTranscodeTemplateGroup查询转码配置详情根据转码模板组ID查询转码配置的详细信息。
DeleteTranscodeTemplateGroup删除转码配置删除转码配置信息,可删除转码模板组下的部分转码模板,也可强制删除整个转码模板组。
截图模板截图模板
AddVodTemplate添加截图模板调用AddVodTemplate添加截图模板。
UpdateVodTemplate修改截图模板修改截图模板。
GetVodTemplate查询单个截图模板调用GetVodTemplate查询单个截图模板。
ListVodTemplate查询截图模板列表查询截图模板列表。
DeleteVodTemplate删除截图模板调用DeleteVodTemplate删除截图模板。
视频水印视频水印
AddWatermark添加水印调用AddWatermark添加水印数据。
UpdateWatermark修改水印调用UpdateWatermark更新水印数据。
DeleteWatermark删除水印调用DeleteWatermark删除水印。
SetDefaultWatermark设置默认水印调用SetDefaultWatermark将制定水印设置为默认水印。
GetWatermark查询单个水印调用GetWatermark查询单个水印数据。
ListWatermark查询水印列表调用ListWatermark查询用户水印数据列表。
转码任务转码任务
GetTranscodeSummary查询音视频转码摘要调用GetTranscodeSummary根据音视频ID查询音视频转码摘要,包括音视频转码状态、转码进展等汇总信息。
ListTranscodeTask查询转码任务列表调用ListTranscodeTask根据音视频ID查询音视频历史转码任务信息,本接口不返回具体的作业信息。
GetTranscodeTask查询转码任务详情调用GetTranscodeTask根据转码任务ID查询转码作业详细信息。

视频编辑(云剪辑)

API标题API概述
ProduceEditingProjectVideo视频合成将一个或多个视频合成为成品。可以通过时间线参数直接提交源视频,也可以先创建云剪辑工程,再提交合成。
云剪辑工程管理云剪辑工程管理
AddEditingProject创建云剪辑工程调用AddEditingProject创建云剪辑工程(视频编辑任务)。
UpdateEditingProject修改云剪辑工程调用UpdateEditingProject修改云剪辑工程(视频编辑任务)。
DeleteEditingProject删除云剪辑工程调用DeleteEditingProject删除云剪辑工程。
SetEditingProjectMaterials设置云剪辑工程素材调用SetEditingProjectMaterials设置云剪辑工程的待剪辑素材。
GetEditingProject获取单个云剪辑工程调用GetEditingProject获取云剪辑工程(视频编辑任务)的详细信息。
GetEditingProjectMaterials获取云剪辑工程素材调用GetEditingProjectMaterials获取云剪辑工程的待剪辑素材列表。
SearchEditingProject搜索云剪辑工程调用SearchEditingProject搜索云剪辑工程(视频编辑列表)。

媒体审核

API标题API概述
审核设置审核设置
SetAuditSecurityIp设置审核安全IP调用SetAuditSecurityIp设置审核安全IP。
ListAuditSecurityIp获取审核安全IP列表调用ListAuditSecurityIp获取审核安全IP列表。
智能审核智能审核
SubmitAIMediaAuditJob提交音视频智能审核作业调用SubmitAIMediaAuditJob提交音视频智能审核作业。作业在提交成功后会异步执行,不保证接口返回时作业已处理完成。
SubmitAIImageAuditJob提交图片智能审核作业调用SubmitAIImageAuditJob来提交图片智能审核任务,作业在提交成功后会异步执行,不保证接口返回时作业已处理完成。
GetAIMediaAuditJob查询智能审核作业调用GetAIMediaAuditJob查询智能审核作业,在提交AI作业后,会进行异步处理,通过此接口可以实时查询作业信息。
GetMediaAuditResult获取智能审核结果摘要调用GetMediaAuditResult获取智能审核结果摘要信息。
GetMediaAuditResultDetail获取智能审核结果详情调用GetMediaAuditResultDetail获取智能审核结果详情。通过此接口可实时查询审核结果详情。
GetMediaAuditResultTimeline获取智能审核结果时间线调用GetMediaAuditResultTimeline获取到所有违规内容截图的时间点。
GetMediaAuditAudioResultDetail获取智能音频审核结果详情调用GetMediaAuditAudioResultDetail获取音频审核详情。
人工审核人工审核
CreateAudit人工审核调用CreateAudit进行人工审核,可用于审核视频、音频等媒体信息。
GetAuditHistory获取人工审核历史调用GetAuditHistory获取人工审核的历史记录。

视频AI

API标题API概述
AI模板AI模板
AddAITemplate添加AI模板调用AddAITemplate添加智能审核和智能封面任务需要使用的AI模板。
DeleteAITemplate删除AI模板调用DeleteAITemplate删除AI模板。
UpdateAITemplate修改AI模板调用UpdateAITemplate修改AI模板。
SetDefaultAITemplate设置默认AI模板调用SetDefaultAITemplate设置默认AI模板。
GetAITemplate查询AI模板调用GetAITemplate查询AI模板。
ListAITemplate查询AI模板列表调用ListAITemplate查询AI模板列表。
GetDefaultAITemplate查询默认AI模板调用GetDefaultAITemplate查询默认AI模板。
AI作业AI作业
ListAIJob查询AI作业调用ListAIJob查询AI作业。在提交AI作业后,会进行异步处理,通过此接口可以实时查询作业信息。
SubmitAIJob提交AI作业调用SubmitAIJob提交AI作业。
视频DNA视频DNA
GetMediaDNAResult获取视频DNA结果调用GetMediaDNAResult获取视频DNA结果。视频DNA作业完成后,可通过此接口实时查询DNA结果。
SubmitMediaDNADeleteJob删除视频DNA作业调用SubmitMediaDNADeleteJob删除视频DNA作业。
智能标签智能标签
GetAIVideoTagResult获取智能标签结果调用GetAIVideoTagResult获取智能标签结果。
智能封面智能封面
SubmitAIImageJob提交AI图片任务调用SubmitAIImageJob接口提交AI图片处理任务。
GetAIImageJobs查询AI图片任务列表调用GetAIImageJobs查询AI图片任务列表。
ListAIImageInfo查询智能封面信息调用ListAIImageInfo查询指定视频下的AI图片信息。
DeleteAIImageInfos删除AI图片信息调用DeleteAIImageInfos删除AI图片信息。

直播转点播

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

点播CDN

API标题API概述
数据监控数据监控
DescribeVodDomainTrafficData查询加速域名的流量数据调用DescribeVodDomainTrafficData获取加速域名的网络流量监控数据。
DescribeVodDomainBpsData查询加速域名的网络带宽调用DescribeVodDomainBpsData获取加速域名的网络带宽监控数据。
域名管理域名管理
AddVodDomain添加加速域名调用AddVodDomain添加点播加速域名。
DeleteVodDomain删除加速域名调用DeleteVodDomain删除已添加的点播加速域名。
UpdateVodDomain修改加速域名调用UpdateVodDomain修改加速域名。
DescribeVodUserDomains查询加速域名列表调用DescribeVodUserDomains查询用户名下所有的点播加速域名列表。
DescribeVodDomainDetail查询域名基本信息调用DescribeVodDomainDetail获取指定点播域名配置的基本信息。
BatchStartVodDomain启用加速域名调用BatchStartVodDomain启用状态为“停用”的加速域名。
BatchStopVodDomain停用加速域名调用BatchStopVodDomain暂停域名加速。
域名验证域名验证
VerifyVodDomainOwner域名归属校验调用VerifyVodDomainOwner校验域名归属。
DescribeVodVerifyContent获取归属校验内容调用DescribeVodVerifyContent获取归属校验内容。
域名配置域名配置
DeleteVodSpecificConfig删除域名配置调用DeleteVodSpecificConfig删除点播加速域名的配置。
SetVodDomainCertificate设置域名证书启用及修改信息调用SetVodDomainCertificate设置某域名下证书功能是否启用及修改证书信息。
DescribeVodDomainConfigs查询域名配置调用DescribeVodDomainConfigs查询域名配置,一次可查询多个功能配置。
DescribeVodCertificateList查询证书列表调用DescribeVodCertificateList获取证书列表信息。
DescribeVodDomainCertificateInfo查询域名证书调用DescribeVodDomainCertificateInfo获取指定加速域名的证书信息。
BatchSetVodDomainConfigs批量配置域名调用BatchSetVodDomainConfigs批量配置加速域名。
刷新预热刷新预热
DescribeVodRefreshTasks查询刷新和预热状态调用DescribeVodRefreshTasks查询刷新和预热状态是否生效。
DescribeVodRefreshQuota查询刷新预热次数限制和余量调用DescribeVodRefreshQuota查询刷新预热URL及目录的最大限制数量和当日剩余数量。
PreloadVodObjectCaches预热缓存调用PreloadVodObjectCaches将源站的内容主动预热到L2 Cache节点上,首次访问可直接命中缓存,缓解源站压力。
RefreshVodObjectCaches刷新缓存调用RefreshVodObjectCaches刷新节点上的文件内容。指定URL内容刷新至Cache节点,支持URL批量刷新。
RefreshMediaPlayUrls提交音视频刷新或预热任务调用RefreshMediaPlayUrls通过音视频ID发起音视频刷新或预热任务。
GetMediaRefreshJobs查询视频刷新或预热任务信息调用GetMediaRefreshJobs查询视频刷新或预热任务的任务状态、筛选策略等任务信息。
日志管理日志管理
DescribeVodDomainLog查询域名日志调用DescribeVodDomainLog获取指定域名的CDN原始访问日志下载地址。

视频安全

API标题API概述
GenerateKMSDataKey创建KMS数据密钥生成一个随机的KMS数据密钥,用于视频点播标准加密。
DecryptKMSDataKey解密KMS数据密钥密文解密KMS数据密钥中的CiphertextBlob密文。

数据统计

API标题API概述
用量数据用量数据
DescribeVodDomainUsageData查询流量带宽用量调用DescribeVodDomainUsageData查询加速流量或带宽用量数据。
DescribeVodStorageData查询存储用量调用DescribeVodStorageData查询媒资管理(存储空间、存储流出流量)的用量。
DescribeVodTranscodeData查询转码用量数据调用DescribeVodTranscodeData查询转码用量数据。
DescribeVodAIData查询AI处理用量数据调用DescribeVodAIData查询AI处理(智能审核、视频DNA等)的用量数据。
播放数据播放数据
DescribePlayTopVideosTOP视频播放数据统计调用DescribePlayTopVideos获取每日TOP视频的播放数据统计(包括播放次数、播放用户数和播放总时长)。
DescribePlayUserAvg播放数据均量统计调用DescribePlayUserAvg获取指定时间范围内的每日播放数据均量统计。
DescribePlayUserTotal播放数据总量统计调用DescribePlayUserTotal获取指定时间范围内的每日播放数据总量统计。
DescribePlayVideoStatis单视频播放数据统计调用DescribePlayVideoStatis获取指定视频在指定时间范围内的每日播放统计数据。

多应用体系

API标题API概述
应用管理应用管理
CreateAppInfo创建应用调用CreateAppInfo创建新的应用。
DeleteAppInfo删除应用调用DeleteAppInfo删除应用信息。
UpdateAppInfo更新应用信息调用UpdateAppInfo更新应用信息。
GetAppInfos查询应用信息调用GetAppInfos通过应用ID查询应用信息。
ListAppInfo获取应用信息列表调用ListAppInfo根据查询条件获取有权限的应用信息列表。
授权管理授权管理
AttachAppPolicyToIdentity为身份实体附加应用授权调用AttachAppPolicyToIdentity为指定身份(RAM用户或RAM角色)附加点播应用的访问权限。
DetachAppPolicyFromIdentity为身份实体撤销应用授权调用DetachAppPolicyFromIdentity为指定账号身份(RAM用户或RAM角色)撤销指定的应用授权。
ListAppPoliciesForIdentity查询身份实体被授予的应用权限列表调用ListAppPoliciesForIdentity列出指定账号身份(RAM用户或RAM角色)被授予的应用权限的列表。
资源迁移资源迁移
MoveAppResource迁移资源到新应用调用MoveAppResource将媒资等资源从一个应用迁移到另外一个应用。应用管理员可以直接转移,RAM用户或RAM角色需要对资源转移前后的两个应用拥有写权限,支持批量迁移。

全局配置

API标题API概述
存储管理存储管理
SetCrossdomainContent更新跨域文件调用SetCrossdomainContent更新点播跨域文件crossdomain.xml的内容。
事件通知事件通知
DeleteMessageCallback删除事件通知配置调用DeleteMessageCallback删除事件通知的回调方式、回调地址、事件类型。
SetMessageCallback设置事件通知配置调用SetMessageCallback设置事件通知的回调方式、回调地址、事件类型。
GetMessageCallback查询事件通知配置调用GetMessageCallback查询事件通知的回调方式、回调地址、事件类型。
阿里云首页 视频点播 相关技术圈