You need to enable JavaScript to run this app.
导航
事件通知概述
最近更新时间:2025.06.19 16:16:16首次发布时间:2021.02.23 10:42:38
我的收藏
有用
有用
无用
无用

本文提供事件通知的功能介绍、回调设置和机制以及对应的事件列表。

功能介绍

视频点播中的各种操作,例如视频上传完成、工作流执行完成等,都可以称为一个事件。由于这些任务都需要一定的时间来完成,为了确保在任务完成后能及时通知您,视频点播提供回调事件通知功能。当一个事件完成后,视频点播会向您发送一条回调消息,以便您能够及时进行下一步的业务处理。视频点播目前支持 HTTP 回调,是指您被动接收视频点播服务事件通知的模式。您可以以空间的粒度来配置回调事件通知功能。

HTTP 回调机制

您需要部署一个 HTTP/HTTPS 服务来接收回调消息,并在视频点播控制台中配置回调地址。视频点播的回调机制具体如下:

  • 当事件发生时,视频点播服务会向您配置的回调地址发起 POST 请求。
  • 您的 HTTP/HTTPS 服务器需返回 200 状态码表示成功,其他状态码表示失败。
  • 如果回调失败,视频点播服务会默认进行重试,最多重试 3 次,重试的时间间隔依次为 5 秒、10 秒和 30 秒。如果仍然未成功,则会丢弃本次回调事件通知。

配置方式

事件列表

视频点播支持的事件类型如下表所示:

事件名称

事件类型

媒资上传完成

FileUploadComplete

URL 批量拉取上传完成

FileUploadByUrlComplete

素材上传完成

MaterialUploadComplete

媒资上传提取元信息完成

UploadGetMetaComplete

媒资删除完成

DeleteMediaComplete

素材文件删除完成

DeleteMaterialComplete

媒体处理产物删除完成

DeleteTranscodesComplete

工作流执行完成

WorkflowComplete

媒体处理任务执行完成

ExecutionComplete

视频剪辑完成

VideoTrackComplete

媒资存储类型修改完成

UpdateMediaStorageClassComplete

文件同步完成

SyncURIComplete

DirectUrl 模式媒资上传完成

FileUploadByUrlComplete

AI 翻译任务执行完成事件

AITranslationComplete

事件解析和编码规范

为确保事件通知能够持续演进并实现功能扩展,事件内容中的结构体在未来可能新增字段。为避免新增字段对您的系统造成影响,建议您在实现事件通知时遵循以下解析和编码规范。

建议的操作

  • 忽略未定义字段:解析 JSON 时,请确保您的程序忽略那些在当前模型中未定义的字段,避免因字段增加而导致异常。
  • 使用灵活的数据结构:使用如下结构进行解析以实现兼容性:
    • TypeScript:Record<string, any>
    • Java:Jackson 默认配置(关闭 FAIL_ON_UNKNOWN_PROPERTIES)
    • Python:dict 类型解析或使用 pydantic 的 extra="allow"
  • JSON Schema 校验时允许额外字段:若使用 JSON Schema 进行数据验证,请勿设置 "additionalProperties": false,否则未来新增字段将导致验证失败。

需避免的操作

操作

可能造成的问题

严格绑定字段到类/对象模型

未定义字段将引发解析错误

使用强类型校验库(如 zod)默认模式

默认拒绝多余字段

JSON Schema 设置 additionalProperties: false

拒绝任何新增字段

示例(以 Java 为例)

推荐配置:

ObjectMapper mapper = new ObjectMapper();
// 忽略未知字段,避免接口变更引发错误
mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);