Overview

更新时间:2024-05-21 11:32:49

Cloud VoD API 使用指南

本文档旨在为您提供关于如何高效利用新版本Cloud VoD API的详尽指南。新版API支持通过OpenAPI接口进行调用,简化测试与API调用的流程。OpenAPI能够便捷地根据您的输入需求生成多种编程语言的示例代码。

旧版API兼容性:若您目前仍在使用旧版本的API,请放心,我们将持续提供对旧版Cloud VoD API的支持。但为了确保您能享受到最佳的服务体验,我们强烈推荐新用户采用新版API。

问题跟踪与解决:新版API将为每个请求/任务分配唯一的ID。这一ID将在响应头的x-cnc-request-id字段中返回给客户端,便于您更有效地跟踪和解决API调用过程中出现的问题。

注意:
由于我们的功能持续更新迭代,API响应可能会包含新的JSON或XML字段。为了保持兼容性并减少错误风险,我们建议您按照JSON和XML的标准来解析这些字段,而非通过字符串直接解析。
此外,请注意,每个客户账户在5分钟内的API调用次数上限为300次,单个API的推荐调用频率为每5分钟30次。若您的业务需求超过这些限制,请及时联系我们的客户支持团队以获取协助。

使用前须知

为确保API调用的安全性,所有请求都需要进行身份验证,并携带有效的令牌。在开始使用Cloud VoD API之前,请确保您已经激活了Cloud VoD服务,并成功获取了用于身份验证的AccessKey Secret。要获取您的AccessKey ID和AccessKey Secret,请登录控制台,并前往安全设置 -> AccessKey管理 -> 显示。请务必妥善保管这些凭据,因为它们是验证您API访问权限的关键。

AccessKey ID和AccessKey Secret获取界面

API概览

上传资源

API 描述
getUploadToken 获取视频上传令牌。
getAudioUploadToken 获取音频上传令牌。
getMaterialUploadToken 获取素材上传令牌。
pullVideo 通过URL检索视频并将其存储在Cloud VoD上,支持批量检索任务。
pullVideoQuery 查询视频拉取任务的完成情况。
upload 将文件上传到Cloud VoD。如果文件大小超过500MB,请使用SDK进行上传。

视频管理

API 描述
getVideoList 检索上传视频及其详细信息的列表,包括上传时间、视频名称、视频ID和视频状态等。
videoEdit 编辑视频的基本信息,如名称、描述、类别和发布域名等。
videoBlock 禁用或屏蔽上传的视频,一旦禁用,视频将不再可见。
videoEnable 重新启用先前禁用的视频。

管理素材

API 描述
getMaterialList 获取已上传素材的列表及其详细信息。
materialEdit 编辑素材的基础信息。
deleteMaterial 删除素材。

管理分类

API 描述
createCategory 创建分类。
deleteCategory 删除分类。
deleteVideoByCategory 根据分类删除视频。
getCategoryList 获取分类列表。

视频处理

API 描述
transCode 对指定视频进行转码。
startWorkflow 对指定视频执行工作流操作,主要用于批量编辑视频信息。
videoClip 对已上传的视频进行剪切。
videoClipQuery 查询剪切任务的状态和结果。
videoConcat 将多个视频按指定顺序拼接,创建新视频。
videoConcatQuery 查询视频拼接任务的状态和结果。
createClearAdTask 为指定视频创建AI去广告任务(这是一项增值服务,需联系客服启用)。
clearAdTaskQuery 查询AI去广告任务的处理状态和结果。

播放

API 描述
getPublishCode 获取不同质量视频播放的URL,用户可以通过该URL观看视频。
本篇文档内容对您是否有帮助?
有帮助
我要反馈
提交成功!非常感谢您的反馈,我们会继续努力做到更好!