服务端 API 概览

最近更新时间:2018-05-23 18:04:01

视频上传

功能名称 API 名称 描述
发起上传 ApplyUpload 发起视频文件的上传,获取文件上传到腾讯云对象存储 COS 的元信息
上传文件 将视频(和封面)文件上传
确认上传 CommitUpload 确认视频文件(和视频封面文件)的上传,获取文件的播放地址和文件 ID
URL 拉取视频上传 MultiPullVodFile 通过用户传递的 URL,从已有的资源库批量拉取视频文件到腾讯云

视频处理

功能名称 API 名称 描述
使用任务流处理视频 RunProcedure 依照指定的流程参数对视频文件进行处理。目前,具体流程参数需要与腾讯云点播商定
对视频文件进行处理 ProcessFile 开发者可以通过该接口对单个视频发起多种处理任务
视频转码 ConvertVodFile 依照控制台中的转码配置,对视频文件进行转码
视频剪辑 ClipVideo 将源视频文件按指定偏移时间进行掐头去尾剪切
视频拼接 ConcatVideo 将多个视频拼接成新视频文件,并添加到点播系统中
指定时间点截图 CreateSnapshotByTimeOffset 获取视频文件在一组时间点的截图
截取雪碧图 CreateImageSprite 对视频文件进行截图,生成雪碧图

媒资管理

功能名称 API 名称 描述
获取视频信息 GetVideoInfo 可以获取单个视频的多种信息,也可以指定回包只返回部分信息
依照视频名称前缀获取视频信息 DescribeVodPlayInfo 根据视频名称前缀搜索视频,并返回其播放信息列表
依照 VID 查询视频信息 DescribeRecordPlayInfo 腾讯云直播、互动直播录制文件会进入点播系统,每个录制文件会有唯一的 video_id(简称 vid)
增加视频标签 CreateVodTags 为视频增加标签
删除视频标签 DeleteVodTags 删除视频的标签
删除视频 DeleteVodFile 删除视频文件
修改视频属性 ModifyVodInfo 修改视频文件的描述信息(包括分类、名称、描述、过期时间等)
增加打点信息 AddKeyFrameDesc 为视频增加打点信息,每个文件最多支持 100 个打点信息。
删除打点信息 DeleteKeyFrameDesc 删除视频的打点信息;支持一次删除单个视频的多个打点信息

视频分类管理

功能名称 API 名称 描述
创建视频分类 CreateClass 用于管理视频文件,增加分类
获取视频分类层次信息 DescribeAllClass 获得当前用户所有的分类层级关系
获取视频分类信息 DescribeClass 获取全局分类列表,以及每个分类的具体信息
修改视频分类 ModifyClass 修改视频分类的属性(包括名称)
删除视频分类 DeleteClass 删除视频分类

事件通知与任务管理

功能名称 API 名称 描述
拉取事件通知 PullEvent 用于从点播服务端获取事件通知
确认事件通知 ConfirmEvent 开发者调用拉取事件通知,获取到事件之后,必须调用该接口来确认消息已经收到
查询任务列表 GetTaskList 查询任务列表,能查询到三天(72小时)内的任务
查询任务信息 GetTaskInfo 用于获取任务的执行情况,只能查询到三天(72小时)内的任务
重试任务 RedoTask 只能重试已结束的三天(72小时)内的任务,执行之后任务ID不会改变,重试成功后会覆盖之前的数据

参数模版管理

功能名称 API 名称 描述
创建转码模板 CreateTranscodeTemplate 创建新的转码模板
查询转码模板列表 QueryTranscodeTemplateList 查询转码模板列表
查询转码模板 QueryTranscodeTemplate 查询转码模板详细信息
更新转码模板 UpdateTranscodeTemplate 更新转码模板
删除转码模板 DeleteTranscodeTemplate 删除转码模板

水印模板管理

功能名称 API 名称 描述
申请上传水印文件 ApplyUploadWatermark 在创建水印模板时,通过该接口获取水印文件的上传 URL
创建水印模板 CreateWatermarkTemplate 创建新的水印模板
查询水印模板列表 QueryWatermarkTemplateList 查询水印模板列表
查询水印模板 QueryWatermarkTemplate 根据水印模板ID,查询水印模板详细信息
更新水印模板 UpdateWatermarkTemplate 更新水印模板
删除水印模板 DeleteWatermarkTemplate 删除水印截图模板

密钥管理

功能名称 API 名称 描述
获取视频解密密钥 DescribeDrmDataKey 用户在视频加密任务处理成功后调用该接口获取视频加密的数据密钥,用户需要自己保存该数据密钥

数据统计

功能名称 API 名称 描述
获取播放统计数据文件下载地址 GetPlayStatLogList 查询每天的播放统计文件下载地址
查询汇总的CDN统计数据 DescribeCdnStat 查询指定域名在指定时间段累计的 CDN 统计数据(流量、带宽、请求数、请求命中率)
查询按地区及运营商分布的CDN统计数据 DescribeCdnRegionIspDetailStat 查询指定域名指定日期按地区、运营商统计的国内 CDN 节点统计数据(流量、带宽、请求数)
查询详细的CDN统计数据 DescribeCdnDetailStat 查询指定域名在指定时间段的 CDN 统计数据明细(流量、带宽、请求数、请求命中率)。
查询域名列表 DescribeVodHosts 查询点播域名的信息。
查询存储统计数据 DescribeStorage 查询使用的点播存储空间。
查询每日播放 Top 100 的视频播放统计数据 DescribePlayStatTopFiles 查询指定日期播放次数 Top 100的视频文件播放统计数据。
获取CDN日志下载链接 GetCdnLogList 获取指定时间段内点播 CDN 的日志下载链接。
查询转码统计数据 DescribeTranscodeStat 查询指定时间段内每天的转码统计数据,包括编码格式、时长和次数。

附录

以下接口是已废弃的服务端 API 接口,具体废弃原因请参见对应文档。

功能名称 API 名称 描述
获取视频信息 DescribeVodPlayUrls 获取当前视频的播放信息(包括播放地址、格式、码率、高度、宽度信息)
批量获取视频信息 DescribeVodInfo 根据 FileID 获取视频属性信息(包括名称、标签、创建时间等)
依照指定流程处理视频 ProcessFileByProcedure 依照指定的流程参数对视频文件进行处理,可以指定的处理流程主要有:转码、创建雪碧图截图等。目前,具体流程参数需要与腾讯云点播商定
HLS 视频简单剪切 SimpleClipHls 将源视频文件按指定偏移时间进行掐头去尾剪切,新生成的视频文件(目标文件)将拥有新的 FileID
截图地址设为视频封面 DescribeVodCover -