Overview
更新时间：2023-10-27 15:11:03
本文档提供了如何使用Cloud VoD API新版本的详细指导。新API通过 OpenAPI 调用，便于测试和API调用。OpenAPI将处理您的请求，并根据您的输入生成各种语言的示例代码。
如果您正在使用API的旧版本，无需担心。我们将继续支持旧版的Cloud VoD API。但是，我们强烈建议新用户采用新版本。在新API中，为了更好地跟踪和解决API调用期间发生的问题，我们为每个请求/任务分配一个唯一ID。该ID将在响应头的"x-cnc-request-id"字段中返回给客户端。
重要提示：由于功能持续更新，API响应可能会添加新的JSON或XML字段。开发者应根据JSON和XML标准解析这些字段，而不是字符串解析。此外，我们限制每个客户账户每5分钟最多可进行300次API调用。单个API的推荐频率为每5分钟30次调用。如果您的需求超过这些限制，请联系我们的客户支持。
使用前须知
出于安全考虑，所有API调用都需要进行身份验证，并且您必须在请求中携带令牌。在使用Cloud VoD API之前，请确保您已激活Cloud VoD服务，并获得了API身份验证所需的AccessKey Secret。要获取您的AccessKey ID和AccessKey Secret，请导航至控制台，然后转到安全设置-> AccessKey管理-> 显示。请妥善保管您的AccessKey ID和AccessKey Secret，因为这些凭据将用于身份验证您的API访问。
API概览
上传资源
| API | 描述 |
|---|---|
| getUploadToken | 获取视频上传令牌。 |
| getAudioUploadToken | 获取音频上传令牌。 |
| getMaterialUploadToken | 获取素材上传令牌。 |
| pullVideo | 该API用于通过URL检索视频。通过调用此API并设置视频检索参数，Cloud VoD将从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去广告任务，系统将自动进行基于AI的去广告操作（这是一项增值服务，在使用API前需要联系客服进行启用）。 |
| clearAdTaskQuery | 查询AI去广告任务的处理状态和结果。 |
播放
| API | 描述 |
|---|---|
| getPublishCode | 获取不同质量视频播放的URL，用户可以直接通过该URL观看视频。 |
本篇文档内容对您是否有帮助？
有帮助
我要反馈