更新事件通知配置--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

更新事件通知配置

最近更新时间：2024.01.31 15:00:37首次发布时间：2023.09.27 17:33:33

本接口支持指定服务 ID 更新该服务的事件通知配置，如事件类型、启用状态、回调 URL 等。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
超时时间：超时时间约为 20 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=UpdateResEventRule&Version=2018-08-01

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

参数	类型	是否必选	示例值	描述
Content-Type	String	是	`application/json`	请求头字段

Query

参数类型是否必选示例值描述

Action String 是 UpdateResEventRule 接口名称。当前 API 的名称为 UpdateResEventRule。

Version String 是 2018-08-01 接口版本。当前 API 的版本为 2018-08-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateResEventRule`	接口名称。当前 API 的名称为 `UpdateResEventRule`。
Version	String	是	`2018-08-01`	接口版本。当前 API 的版本为 `2018-08-01`。
ServiceId	String	是	`hj9**102`	服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

hj9**102

服务 ID。

您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

参数	类型	是否必选	示例值	描述
EventRules	Array of EventRules	是	`-`	事件通知规则

EventRules

参数	类型	是否必选	示例值	描述
EventType	Array of String	是	`upload`	事件类型。取值如下所示： `Upload`：上传文件 `Delete`：删除文件 `Mirror`：镜像回源 `Migrate`：数据迁移 `OffTrans`：离线转码（素材托管服务配置无效） `TplStore`：模板持久化存储（素材托管服务配置无效）
MatchRule	String	否	`\test\.png\b`	匹配规则的正则表达式。仅当资源的 `StoreKey` 匹配该正则表达式时触发事件通知。缺省情况下表示匹配所有资源。
CallbackUrl	String	是	`https://a.callback.com`	回调 URL，以 http:// 或 https:// 开头，需满足公网可访问。当事件触发时，会向该 URL 发送 HTTP POST 请求，body 为具体的事件信息。具体回调参数详见回调内容。
Enable	Boolean	是	`true`	规则启用状态，取值如下所示： `true`：开启 `false`：关闭

返回参数

无

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateResEventRule&Version=2018-08-01&ServiceId=hj9%2A%2A102
{
  "EventRules": [
    {
      "EventType": [
        "Upload"
      ],
      "Enable": true,
      "MatchRule": "\test\.png\b",
      "CallbackUrl": "https://a.callback.com"
    }
  ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "UpdateResEventRule",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {}
}

错误码

访问公共错误码和 veImageX 错误码获取详细信息。

回调内容

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

回调参数	说明
AccountId	账号 ID
ServiceId	服务 ID
EventType	事件类型
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": ""
}