You need to enable JavaScript to run this app.
导航
事件通知
最近更新时间:2024.11.15 13:33:59首次发布时间:2023.09.27 17:33:33

veImageX 支持您在控制台设置事件通知规则,来自定义需要关注的存储文件和变动规则(例如新文件上传、文件删除)。规则被触发时 veImageX 会向设置的回调 URL 发送结果通知,您可根据通知及时进行数据处理(如文件上传后自动预热等)、数据分析、资源备份等操作。

注意事项

  • 最多可创建 10 条事件通知规则。
  • 若文件上传时跳过 Commit 上报,则事件通知配置无效。
  • 事件通知为异步执行,通知结果不影响上传、删除等相关接口的返回值。
  • 若匹配规则中包含了文件的最新版本、历史版本、删除标记,那么当以上文件被删除时,均会触发设置的事件通知规则。

创建事件通知规则

  1. 登录 veImageX 控制台,选择并进入服务管理

  2. 选择服务,并单击基础配置按钮,并进入该页面。

  3. 存储配置页签找到事件通知后,单击修改后点击新建通知规则,配置具体规则。

    配置项说明

    事件类型

    多选,你希望接收的通知事件。支持以下类型:

    说明

    仅当服务为图片处理服务时,支持配置离线转码与模板持久化存储这两个事件类型。

    匹配规则匹配规则的正则表达式。仅当资源的 StoreKey 匹配该正则表达式时触发事件通知。
    回调 URL回调 URL,以 http:// 或 https:// 开头,需满足公网可访问。当事件触发时,会向该 URL 发送 HTTP POST 请求,具体回调参数详见回调内容
    启用状态默认为开启状态,您可手动关闭。
    操作单击删除图标,删除该条规则。
  4. 单击保存按钮,保存当前规则。

消息通知

当资源触发事件时 veImageX 将会把触发结果以固定格式回调至您的自定义回调 URL 中。您可以通过回调内容,进行后续的处理操作,具体如下所示:

回调参数说明
AccountId账号 ID
ServiceId服务 ID

EventType

事件类型,取值如下所示:

  • Upload:上传文件
  • Delete:删除文件
  • Mirror:镜像回源
  • Migrate:数据迁移
  • OffTrans:离线转码
  • TplStore:模板持久化存储
StoreUri触发事件的资源存储 URI
StoreKey触发事件的资源存储 Key
Timestamp触发事件的 Unix 时间戳
SourceIp触发事件请求源 IP,仅满足上传和删除两个事件时有值。
Size触发事件的资源大小,仅为非删除类事件时有值。单位为 Byte。
ContentType触发事件的资源 content-type,仅为非删除类事件时有值。

JSON 类型回调示例如下所示:

{
   "AccountId": "982730***013081",
   "ServiceId": "u1**01",
   "EventType": "Delete",
   "StoreUri": "tos-cn-i-5s**fo/f2**9a.png",
   "StoreKey": "f2**9a.png",
   "Timestamp": 1692849000,
   "SourceIp": "xxx.xxx.x.xxx",
   "Size": ,
   "ContentType": ""
}

OpenAPI

您可以通过调用 OpenAPI 更新事件通知配置,具体请参考UpdateResEventRule