视频点播_API文档

视频点播 - OpenAPI 概览2017-03-21
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
媒体上传
OpenAPI 名称描述操作
CreateUploadVideohot点播服务下发上传地址和凭证以保障授权和安全,防止恶意上传,并在下发时自动创建媒体ID(MediaId),也叫视频ID(VideoId)用于管理。通过调用本接口可获取上传所需地址和凭证,并创建音视频信息查看文档去调试
CreateUploadImage点播服务下发上传地址和凭证以保障授权和安全,防止恶意上传,并在下发时自动创建图片ID(ImageId)用于管理。通过调用本接口可获取上传所需地址和凭证,并创建图片信息查看文档去调试
CreateUploadAttachedMedia上传地址和凭证由点播服务提供,旨在解决授权与安全问题,防止恶意上传,并自动创建用于管理和处理的媒资ID(Mediaid)。辅助媒资如水印、字幕等,通过调用本接口获取上传凭证并创建相应媒资信息查看文档去调试
GetURLUploadInfoshot获取URL上传信息查看文档去调试
GetUploadDetails通过媒体ID获取媒体上传详情(如上传时间、已上传比例、上传来源等信息),支持批量获取查看文档去调试
DeleteMultipartUpload删除上传中产生的碎片文件查看文档去调试
RefreshUploadVideohot用于视频文件上传超时后重新获取视频上传凭证查看文档去调试
UploadMediaByURLhot基于源文件URL,拉取音视频媒体文件进行上传,支持批量上传查看文档去调试
CancelUrlUploadJobs取消排队中的URL上传任务查看文档去调试
UploadStreamByURL上传外部存储的转码流文件并挂载到对应的点播媒资下查看文档去调试
RegisterMedia进行媒资注册,接入点播服务的OSS自有Bucket上的存量媒资文件,需要进行媒资注册生成点播需要的关联数据后,才能正常使用点播提供的转码、截图等功能查看文档去调试
音视频播放
OpenAPI 名称描述操作
GetPlayInfohot调用此接口并提供音视频ID即可获取播放地址,随后可使用阿里云播放器或第三方播放器(如系统原生、开源或自研播放器)播放音视频内容查看文档去调试
GetVideoPlayAuthhot调用本接口获取音视频的播放凭证(PlayAuth)。阿里云播放器SDK使用该凭证自动获取播放地址。由于播放凭证具有时效性,且与特定音视频绑定,不可混用或重复使用,因此凭证过期或无效将导致无法播放。此播放方式适用于需要高安全性的音视频播放场景查看文档去调试
媒资管理
OpenAPI 名称描述操作
媒资搜索
SearchMediahot本接口用于搜索视频点播生产的视频、音频和图片等媒资信息,调用本接口配合媒资搜索协议可实现在视频点播中进行指定返回字段、精确匹配、模糊匹配、多值查询、范围查询、排序字段等多方式多维度的搜索查询查看文档去调试
分级存储
UpdateMediaStorageClass修改媒资存储类型查看文档去调试
RestoreMedia解冻媒资查看文档去调试
分类管理
AddCategory通过调用本接口来创建分类,可以有效地对存储在视频点播平台上的音视频、图片及短视频素材进行归类,从而使得资源的查找与管理变得更加高效便捷查看文档去调试
GetCategories调用本接口按ID或类型来筛选查询指定的分类信息,及其子分类(即下一级分类)的列表查看文档去调试
UpdateCategory调用本接口对分类名称进行修改更新查看文档去调试
DeleteCategory调用本接口删除分类及其子分类查看文档去调试
音视频管理
GetVideoInfohot调用本接口通过音/视频ID来获取单个音视频的标题、描述、时长、封面URL、状态、创建时间、大小、截图、分类和标签等信息查看文档去调试
GetVideoInfos调用本接口通过音/视频ID批量获取多个音视频的标题、描述、时长、封面URL、状态、创建时间、大小、截图、分类和标签等信息查看文档去调试
GetVideoListhot获取视频信息列表查看文档去调试
GetMezzanineInfohot获取音视频的源文件信息,包括文件地址、分辨率、码率等查看文档去调试
DescribeMediaDistribution查询音视频媒资数据按时间分布。起止时间跨度最大6个月查看文档去调试
UpdateVideoInfo修改单个音视频信息查看文档去调试
UpdateVideoInfos批量修改音视频信息查看文档去调试
DeleteMezzanines批量删除音视频源文件信息查看文档去调试
DeleteStream删除媒体流(视频流,音频流)信息及存储文件查看文档去调试
DeleteVideo删除完整视频(包括视频源文件、转码后的流文件、封面截图等)查看文档去调试
BatchGetMediaInfos批量获取媒资基础信息和源文件信息查看文档去调试
辅助媒资管理
GetAttachedMediaInfo当水印图片、字幕文件、素材等辅助媒资上传到视频点播后,可以调用本接口传入多个辅助媒资ID批量获取辅助媒资的基本信息及访问地址查看文档去调试
UpdateAttachedMediaInfos当将带有水印的图片、字幕文件或其它素材等辅助媒体资源上传至视频点播后,可以通过本接口依据这些辅助媒体的唯一标识符(ID),批量更新它们的标题、描述、标签及分类等信息查看文档去调试
DeleteAttachedMedia当水印图片、字幕文件、素材等辅助媒体资源上传至视频点播后,可以利用本接口能进行单个或批量的删除操作查看文档去调试
图片管理
GetImageInfo图片上传至视频点播后,可调用本接口通过图片ID获取其基本信息及访问地址查看文档去调试
GetImageInfos图片上传到视频点播后,可以调用本接口通过传入多个图片ID,批量获取图片的基本信息及访问地址查看文档去调试
ListSnapshots调用本接口可以查询通过视频截图作业生成的截图,以及视频上传时系统生成的封面截图查看文档去调试
UpdateImageInfos图片上传到视频点播后,可以调用本接口通过图片ID批量修改图片的标题、描述、标签和分类信息查看文档去调试
DeleteImage调用本接口删除用户上传的图片或视频截图生成的图片查看文档去调试
动图管理
ListDynamicImage调用本接口,通过视频ID查询视频截动图列表查看文档去调试
DeleteDynamicImage调用本接口删除动图信息查看文档去调试
媒体处理
OpenAPI 名称描述操作
发起处理
SubmitTranscodeJobs调用本接口提交媒体转码作业,开始异步转码处理查看文档去调试
SubmitSnapshotJob调用本接口提交视频截图作业,开始异步截图处理查看文档去调试
SubmitPreprocessJobs调用本接口通过导播台对视频进行转码处理查看文档去调试
SubmitDynamicImageJob调用本接口提交媒体动图作业,开始异步处理查看文档去调试
SubmitWorkflowJob对视频发起点播工作流处理查看文档去调试
转码模板
AddTranscodeTemplateGroup调用本接口添加转码配置信息,可创建新的转码模板组,或者向指定模板组中添加新的转码模板查看文档去调试
ListTranscodeTemplateGroup调用本接口查询转码模板配置列表查看文档去调试
GetTranscodeTemplateGroup根据转码模板组ID查询转码配置的详细信息查看文档去调试
UpdateTranscodeTemplateGroup调用本接口修改转码配置信息,可修改转码模板组下指定的转码模板配置查看文档去调试
SetDefaultTranscodeTemplateGroup调用本接口设置默认转码模板配置查看文档去调试
DeleteTranscodeTemplateGroup删除转码配置信息,可删除转码模板组下的部分转码模板,也可强制删除整个转码模板组查看文档去调试
截图模板
GetVodTemplate调用本接口查询单个截图模板查看文档去调试
UpdateVodTemplate修改截图模板查看文档去调试
AddVodTemplate调用本接口添加截图或动图模板查看文档去调试
ListVodTemplate查询截图模板列表查看文档去调试
DeleteVodTemplate调用本接口删除截图模板查看文档去调试
图文水印模板
AddWatermark为了简化水印任务的处理过程,视频点播将复杂的水印位置、水印大小、水印文字的字体、颜色等水印参数固化成模板,并通过具有唯一性的水印模板ID来指代。调用本接口可以添加图片水印模板或文字水印模板查看文档去调试
GetWatermark调用本接口通过水印模板ID查询单个图片水印模板或文字水印模板的配置信息,包括图片水印的位置、大小,展示时间,文字水印的内容、字体、颜色、位置等参数配置信息查看文档去调试
ListWatermark调用本接口查询当前服务地域下已添加的所有图片水印模板和文字水印模板的配置信息,包括图片水印的位置、大小,展示时间,文字水印的内容、字体、颜色、位置等参数配置信息查看文档去调试
UpdateWatermark添加图文水印模板后,可以调用本接口修改图文水印模板的模板名称和水印配置(WatermarkConfig)查看文档去调试
SetDefaultWatermark调用本接口将指定水印模板设置为默认水印模板查看文档去调试
DeleteWatermark调用本接口通过水印模板ID删除图片水印模板或文字水印模板查看文档去调试
转码任务
GetTranscodeSummary调用本接口根据音视频ID查询音视频转码摘要,包括音视频转码状态、转码进展等汇总信息查看文档去调试
ListTranscodeTask调用本接口根据音视频ID查询音视频历史转码任务信息,本接口不返回具体的作业信息查看文档去调试
GetTranscodeTask调用本接口根据转码任务ID查询转码作业详细信息查看文档去调试
任务管理
ListJobInfo调用本接口根据媒资ID查询历史任务列表查看文档去调试
GetJobDetail调用本接口根据jobId查询异步任务详情查看文档去调试
视频编辑(云剪辑)
OpenAPI 名称描述操作
云剪辑工程管理
AddEditingProject调用本接口创建云剪辑工程(视频编辑任务)查看文档去调试
GetEditingProject调用本接口进行获取云剪辑工程(视频编辑任务)的详细信息查看文档去调试
GetEditingProjectMaterials调用本接口获取云剪辑工程的待剪辑素材列表查看文档去调试
SearchEditingProject调用本接口搜索云剪辑工程(视频编辑列表)查看文档去调试
UpdateEditingProject调用本接口修改云剪辑工程(视频编辑任务)查看文档去调试
SetEditingProjectMaterials调用本接口设置云剪辑工程的待剪辑素材查看文档去调试
DeleteEditingProject调用本接口删除云剪辑工程查看文档去调试
AddEditingProjectMaterials将一个或多个素材添加到剪辑工程中查看文档去调试
DeleteEditingProjectMaterials删除云剪辑工程的待剪辑素材查看文档去调试
ProduceEditingProjectVideo将一个或多个视频合成为成品。可以通过时间线参数直接提交源视频,也可以先创建云剪辑工程,再提交合成查看文档去调试
媒体审核
OpenAPI 名称描述操作
审核设置
ListAuditSecurityIp调用本接口获取审核安全IP列表查看文档去调试
SetAuditSecurityIp调用本接口设置审核安全IP查看文档去调试
智能审核
GetAIMediaAuditJob调用本接口查询智能审核作业,在提交AI作业后,会进行异步处理,通过此接口可以实时查询作业信息查看文档去调试
GetMediaAuditResult调用本接口获取智能审核结果摘要信息查看文档去调试
GetMediaAuditResultDetail调用本接口获取智能审核结果详情。通过此接口可实时查询审核结果详情查看文档去调试
GetMediaAuditResultTimeline调用本接口获取到所有违规内容截图的时间点查看文档去调试
GetMediaAuditAudioResultDetail调用本接口获取音频审核详情查看文档去调试
SubmitAIMediaAuditJob调用本接口提交音视频智能审核作业。作业在提交成功后会异步执行,不保证接口返回时作业已处理完成查看文档去调试
SubmitAIImageAuditJob调用本接口来提交图片智能审核任务,作业在提交成功后会异步执行,不保证接口返回时作业已处理完成查看文档去调试
人工审核
CreateAudit调用本接口进行人工审核,可用于审核视频、音频等媒体信息查看文档去调试
GetAuditHistory调用本接口获取人工审核的历史记录查看文档去调试
视频AI
OpenAPI 名称描述操作
AI模板
AddAITemplate调用本接口添加智能审核和智能封面任务需要使用的AI模板查看文档去调试
GetAITemplate调用本接口查询AI模板查看文档去调试
ListAITemplate调用本接口查询AI模板列表查看文档去调试
GetDefaultAITemplate调用本接口查询默认AI模板查看文档去调试
UpdateAITemplate调用本接口修改AI模板查看文档去调试
SetDefaultAITemplate调用本接口设置默认AI模板查看文档去调试
DeleteAITemplate调用本接口删除AI模板查看文档去调试
AI作业
ListAIJob调用本接口查询智能标签或视频DNA作业。在提交智能标签或视频DNA作业后,会进行异步处理,通过此接口可以实时查询作业信息查看文档去调试
SubmitAIJob调用本接口提交智能标签或视频DNA作业查看文档去调试
视频DNA
GetMediaDNAResult调用本接口获取视频DNA结果。视频DNA作业完成后,可通过此接口实时查询DNA结果查看文档去调试
SubmitMediaDNADeleteJob调用本接口删除视频DNA作业查看文档去调试
智能标签
GetAIVideoTagResult调用本接口获取智能标签结果查看文档去调试
智能封面
GetAIImageJobs调用本接口查询AI图片任务列表查看文档去调试
ListAIImageInfo调用本接口查询指定视频下的AI图片信息查看文档去调试
DeleteAIImageInfos调用本接口删除AI图片信息查看文档去调试
SubmitAIImageJob调用本接口提交AI图片处理任务查看文档去调试
直播转点播
OpenAPI 名称描述操作
ListLiveRecordVideo调用本接口获取直播转点播视频列表查看文档去调试
点播CDN
OpenAPI 名称描述操作
监控查询
资源访问数据
DescribeVodDomainTrafficData调用本接口查询加速域名的流量数据,相比DescribeVodDomainRealTimeTrafficData接口,本接口支持可查询的历史数据时间范围更长(最长可查询最近366天的数据),但其数据时间粒度更大(最小为5分钟),数据延迟更高查看文档去调试
DescribeVodDomainBpsData调用本接口查询加速域名的带宽数据,相比DescribeVodDomainRealTimeBpsData接口,本接口支持可查询的历史数据时间范围更长(最长可查询最近366天的数据),但其数据时间粒度更大(最小为5分钟),数据延迟更高查看文档去调试
DescribeVodDomainBpsDataByLayer调用本接口按协议类型查询加速域名的带宽数据查看文档去调试
DescribeVodDomainQpsData获取5分钟计算粒度加速域名的每秒访问次数QPS,支持获取最近90天的数据查看文档去调试
DescribeVodDomainHitRateData调用本接口查询加速域名的字节命中率(命中字节百分比)查看文档去调试
DescribeVodDomainReqHitRateData调用本接口查询加速域名的请求命中率(命中请求百分比)查看文档去调试
DescribeVodRangeDataByLocateAndIspService调用本接口按运营商或地域查询加速域名的访问数据,包括带宽、响应平均速率、页面浏览量、缓存命中率、请求命中率等数据查看文档去调试
资源回源数据
DescribeVodDomainSrcTrafficData调用本接口查询加速域名的回源流量数据查看文档去调试
DescribeVodDomainSrcBpsData调用本接口查询加速域名的回源带宽数据查看文档去调试
实时访问数据
DescribeVodDomainRealTimeTrafficData调用本接口查询加速域名的流量数据,相比DescribeVodDomainTrafficData接口,本接口支持查询的数据时间粒度更小(最小为1分钟),数据延迟更低(最少为5分钟),但可查询的历史数据时间范围更短(最长可查询最近186天的数据)查看文档去调试
DescribeVodDomainRealTimeBpsData调用本接口查询加速域名的带宽数据,相比DescribeVodDomainBpsData接口,本接口支持查询的数据时间粒度更小(最小为1分钟),数据延迟更低(最少为5分钟),但可查询的历史数据时间范围更短(最长可查询最近186天的数据)查看文档去调试
DescribeVodDomainRealTimeHttpCodeData调用本接口查询加速域名HTTP状态码的总数和占比数据。本接口支持查询的数据时间粒度最小为1分钟,数据延迟最少为5分钟,最长可查询最近186天的数据查看文档去调试
DescribeVodDomainRealTimeQpsData调用本接口查询加速域名每秒访问次数的数据。本接口支持查询的数据时间粒度最小为1分钟,数据延迟最少为5分钟,最长可查询最近186天的数据查看文档去调试
DescribeVodDomainRealTimeReqHitRateData调用本接口查询加速域名的请求命中率数据。本接口支持查询的数据时间粒度最小为1分钟,数据延迟最少为5分钟,最长可查询最近186天的数据查看文档去调试
DescribeVodDomainRealTimeByteHitRateData调用本接口查询加速域名的字节命中率数据。本接口支持查询的数据时间粒度最小为1分钟,数据延迟最少为5分钟,最长可查询最近186天的数据查看文档去调试
DescribeVodDomainRealTimeDetailData调用本接口查询加速域名的实时访问数据,可查询最近7天内的QPS、带宽、HTTP状态码数据查看文档去调试
域名管理
AddVodDomain调用本接口添加点播加速域名查看文档去调试
DescribeVodUserDomains调用本接口查询用户名下所有的点播加速域名列表查看文档去调试
DescribeVodDomainDetail调用本接口获取指定点播域名配置的基本信息查看文档去调试
UpdateVodDomain调用本接口修改加速域名查看文档去调试
DeleteVodDomain调用本接口删除已添加的点播加速域名查看文档去调试
BatchStartVodDomain调用本接口启用状态为“停用”的加速域名查看文档去调试
BatchStopVodDomain调用本接口暂停域名加速查看文档去调试
域名验证
VerifyVodDomainOwner调用本接口验证域名归属权查看文档去调试
DescribeVodVerifyContent调用本接口获取归属校验内容查看文档去调试
域名配置
DescribeVodDomainConfigs调用本接口查询域名配置,一次可查询多个功能配置查看文档去调试
DescribeVodCertificateList调用本接口获取证书列表信息查看文档去调试
DescribeVodDomainCertificateInfo调用本接口获取指定加速域名的证书信息查看文档去调试
SetVodDomainCertificate调用本接口设置某域名下证书功能是否启用及修改证书信息查看文档去调试
DeleteVodSpecificConfig调用本接口删除点播加速域名的配置查看文档去调试
BatchSetVodDomainConfigs调用本接口批量配置加速域名查看文档去调试
刷新预热
DescribeVodRefreshTasks调用本接口查询刷新和预热状态是否生效查看文档去调试
DescribeVodRefreshQuota调用本接口查询刷新预热URL及目录的最大限制数量和当日剩余数量查看文档去调试
PreloadVodObjectCaches调用本接口将源站的内容主动预热到L2 Cache节点上,首次访问可直接命中缓存,缓解源站压力查看文档去调试
RefreshVodObjectCaches调用本接口刷新节点上的文件内容。指定URL内容刷新至Cache节点,支持URL批量刷新查看文档去调试
RefreshMediaPlayUrls调用本接口通过音视频ID发起音视频刷新或预热任务查看文档去调试
GetMediaRefreshJobs调用本接口查询视频刷新或预热任务的任务状态、筛选策略等任务信息查看文档去调试
日志管理
DescribeVodDomainLog调用本接口获取指定域名的CDN原始访问日志下载地址查看文档去调试
视频安全
OpenAPI 名称描述操作
HLS标准加密
GenerateKMSDataKey通过调用本接口生成一个随机的KMS数据密钥,用于视频点播标准加密查看文档去调试
DecryptKMSDataKey通过调用本接口解密KMS数据密钥中的CiphertextBlob密文查看文档去调试
数字水印
SubmitDigitalWatermarkExtractJob通过调用本接口提交数字水印(版权水印或溯源水印)提取作业,开始异步提取版权水印或溯源水印查看文档去调试
GetDigitalWatermarkExtractResult通过调用本接口查询数字水印(版权水印或溯源水印)的提取作业结果,包括数字水印提取作业的状态、成功提取出的水印文字等信息查看文档去调试
安全下载(缓存)
GenerateDownloadSecretKey阿里云播放器SDK的安全下载功能,可使视频下载到本地时经密钥文件进行加密,让其仅能通过预先绑定的唯一App生成的密钥文件进行解密播放,可有效保护视频内容,防止下载到本地的视频被恶意播放或传播。调用本接口可生成用于安全下载的密钥查看文档去调试
数据统计
OpenAPI 名称描述操作
用量数据
DescribeVodDomainUsageData调用本接口查询加速流量或带宽用量数据查看文档去调试
DescribeVodStorageData调用本接口查询媒资管理(存储空间、存储流出流量)的用量查看文档去调试
DescribeVodTranscodeData调用本接口查询转码用量数据查看文档去调试
DescribeVodAIData调用本接口查询AI处理(智能审核、视频DNA等)的用量数据查看文档去调试
DescribeVodTieringStorageData查询媒资管理分级存储的用量查看文档去调试
DescribeVodTieringStorageRetrievalData查询媒资管理分级存储的取回数据用量查看文档去调试
播放数据(新)
DescribeVodMediaPlayData通过媒体ID(即音视频ID)获取音视频在指定日期的播放数据,包括访问用户数、人均播放次数、播放总次数、人均播放时长、累计播放时长等数据查看文档去调试
播放数据(旧)
DescribePlayTopVideos调用本接口获取每日TOP视频的播放数据统计,统计指标包括播放次数、播放用户数和播放总时长查看文档去调试
DescribePlayUserAvg调用本接口获取指定时间范围内的每日播放数据均量统计,统计指标包括平均播放时长、平均播放次数查看文档去调试
DescribePlayUserTotal调用本接口获取指定时间范围内的每日播放数据总量统计,统计指标包括总播放次数、总播放用户数、总播放时长、播放时长分布查看文档去调试
DescribePlayVideoStatis调用本接口查询指定视频在指定时间范围内的每日播放统计数据,统计指标包括播放总时长、播放次数、播放用户数和播放时长分布查看文档去调试
多应用体系
OpenAPI 名称描述操作
应用管理
CreateAppInfo调用本接口创建新的应用查看文档去调试
GetAppInfos调用本接口通过应用ID查询应用信息查看文档去调试
ListAppInfo调用本接口根据查询条件获取有权限的应用信息列表查看文档去调试
UpdateAppInfo调用本接口更新应用信息查看文档去调试
DeleteAppInfo调用本接口删除应用信息查看文档去调试
AddVodStorageForApp为视频点播的子应用绑定存储Bucket查看文档去调试
授权管理
ListAppPoliciesForIdentity调用本接口列出指定账号身份(RAM用户或RAM角色)被授予的应用权限的列表查看文档去调试
AttachAppPolicyToIdentity调用本接口为指定身份(RAM用户或RAM角色)附加点播应用的访问权限查看文档去调试
DetachAppPolicyFromIdentity调用本接口为指定账号身份(RAM用户或RAM角色)撤销指定的应用授权查看文档去调试
资源迁移
MoveAppResource调用本接口将媒资等资源从一个应用迁移到另外一个应用。应用管理员可以直接转移,RAM用户或RAM角色需要对资源转移前后的两个应用拥有写权限,支持批量迁移查看文档去调试
全局配置
OpenAPI 名称描述操作
存储管理
SetCrossdomainContent调用本接口更新点播跨域文件crossdomain.xml的内容查看文档去调试
事件通知
GetMessageCallback调用本接口查询事件通知的回调方式、回调地址、事件类型查看文档去调试
SetMessageCallback调用本接口设置事件通知的回调方式、回调地址、事件类型查看文档去调试
DeleteMessageCallback调用本接口删除事件通知的回调方式、回调地址、事件类型查看文档去调试
其他
OpenAPI 名称描述操作
ChangeResourceGroup调用本接口将资源进行转组查看文档去调试
DescribeVodDomainMax95BpsData调用本接口查询加速域名95带宽峰值监控数据查看文档去调试
DescribeVodSSLCertificateList调用本接口按照域名查询证书列表信息查看文档去调试
SetVodDomainSSLCertificate调用本接口用于设置某域名下证书功能是否启用及更新证书信息查看文档去调试
DescribeVodEditingUsageData查询点播云剪辑用量查看文档去调试
2024年08月20日