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 获取辅助媒资上传地址和凭证 获取辅助媒资上传地址和凭证,辅助媒资包括水印、字幕、素材等。
UploadMediaByURL URL批量拉取上传 基于源文件URL,拉取音视频媒体文件进行上传,支持批量上传。
GetURLUploadInfos 获取URL上传信息 获取URL上传信息。
CancelUrlUploadJobs 取消URL上传任务 取消排队中的URL上传任务。
UploadStreamByURL 通过URL上传转码流 上传外部存储的转码流文件并挂载到对应的点播媒资下。
DeleteMultipartUpload 删除上传中的碎片文件 删除上传中产生的碎片文件。
GetUploadDetails 获取媒体上传详情 通过媒体ID获取媒体上传详情(如上传时间、已上传比例、上传来源等信息),支持批量获取。
RegisterMedia 注册媒资信息 调用RegisterMedia进行媒资注册,接入点播服务的OSS自有Bucket上的存量媒资文件,需要进行媒资注册生成点播需要的关联数据后,才能正常使用点播提供的转码、截图等功能。

音视频播放

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

媒资管理

API 标题 API概述
媒资搜索 媒资搜索
SearchMedia 搜索媒体信息 搜索媒资信息,包括视频、音频、图片、辅助媒资等。
媒资分类 媒资分类
AddCategory 创建分类 创建媒资分类。
UpdateCategory 更新分类 修改媒资分类。
DeleteCategory 删除分类 删除媒资分类。
GetCategories 获取分类及子分类 获取指定的分类信息,及其子分类(即下一级分类)的列表。
音视频管理 音视频管理
GetVideoInfo 获取单个音视频信息 获取单个音视频的基本信息。
GetVideoInfos 批量获取音视频信息 批量获取音视频信息。
GetVideoList 获取音视频信息列表 获取视频信息列表。
GetMezzanineInfo 获取源文件信息 获取音视频的源文件信息,包括文件地址、分辨率、码率等。
UpdateVideoInfo 修改单个音视频信息 修改单个音视频信息。
UpdateVideoInfos 批量修改音视频信息 批量修改音视频信息。
DeleteMezzanines 批量删除音视频源文件 批量删除音视频源文件信息。
DeleteStream 删除媒体流 删除媒体流(视频流,音频流)信息及存储文件。
DeleteVideo 删除完整视频 删除完整视频(包括视频源文件、转码后的流文件、封面截图等)。
辅助媒资管理 辅助媒资管理
GetAttachedMediaInfo 获取辅助媒资信息 获取辅助媒资的基本信息,包括标题、类型、标签、创建时间等。
UpdateAttachedMediaInfos 更新辅助媒资信息 调用UpdateAttachedMediaInfos批量修改辅助媒资信息。
DeleteAttachedMedia 删除辅助媒资 删除辅助媒资,支持批量删除。
图片管理 图片管理
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 提交点播工作流作业 对视频发起点播工作流处理。
转码模板 转码模板
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获取加速域名的网络带宽监控数据。
DescribeVodDomainSrcTrafficData 查询加速域名的回源流量 调用DescribeVodDomainSrcTrafficData查询视频点播中加速域名的回源流量监控数据,单位:Byte。
DescribeVodDomainSrcBpsData 查询加速域名的回源带宽 调用DescribeVodDomainSrcBpsData查询视频点播中加速域名的回源带宽监控数据,单位:bit/s。
域名管理 域名管理
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等)的用量数据。
播放数据 播放数据
DescribePlayTopVideos TOP视频播放数据统计 调用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查询事件通知的回调方式、回调地址、事件类型。
阿里云首页 视频点播 相关技术圈