文档基于2025-10-10日社区最终版构建     
切换到英文版    进入演示系统    进入交流社区

MinIO Documentation

Webhook 服务通知设置

本页记录了将 Webhook 服务配置为目标的设置存储桶通知.发布事件到Webhook有关使用这些设置的教程。

您可以通过定义以下内容来建立或修改设置:

  • an 环境变量在启动或重启 MinIO 服务器之前,请在主机系统上设置此环境变量。 有关如何定义环境变量,请参阅操作系统的文档。

  • a 配置设置使用mc admin config set.

如果您同时定义了环境变量和类似的配置设置,MinIO 将使用环境变量的值。

某些设置只有环境变量或配置设置,但没有两者都提供。

重要

每个配置设置控制着 MinIO 的基本行为和功能。 MinIO强烈建议在应用到生产环境之前,先在较低环境(如开发环境或测试环境)中测试配置变更。

多Webhook服务目标

您可以通过附加唯一标识符来指定多个 Webhook 服务端点_ID对于每组相关的 Webhook 设置,请将其置于顶层键下。 例如,以下命令设置了两个不同的 Webhook 服务端点:PRIMARYSECONDARY分别:

export MINIO_NOTIFY_WEBHOOK_ENABLE_PRIMARY="on"
export MINIO_NOTIFY_WEBHOOK_ENDPOINT_PRIMARY="https://webhook1.example.net"

export MINIO_NOTIFY_WEBHOOK_ENABLE_SECONDARY="on"
export MINIO_NOTIFY_WEBHOOK_ENDPOINT_SECONDARY="https://webhook1.example.net"
mc admin config set notify_webhook:primary \
   endpoint="https://webhook1.example.net"
   [ARGUMENT=VALUE ...]

mc admin config set notify_webhook:secondary \
   endpoint="https://webhook2.example.net
   [ARGUMENT=VALUE ...]

设置

启用

必需

MINIO_NOTIFY_WEBHOOK_ENABLE

指定on以启用将存储桶通知发布到 Webhook 服务端点。

默认值为off.

notify_webhook

用于定义 Webhook 服务端点的顶级配置键MinIO 存储桶通知.

使用mc admin config set设置或更新 Webhook 服务端点。endpoint参数是必需for each target. 指定额外的可选参数作为空格(" ")-分隔的列表。

mc admin config set notify_webhook \
  endpoint="https://webhook.example.net"
  [ARGUMENT="VALUE"] ... \

端点

必需

MINIO_NOTIFY_WEBHOOK_ENDPOINT
notify_webhook 端点

指定 Webhook 服务的 URL。

Changed in version RELEASE.2023-05-27T05-56-19Z:MinIO 在添加目标之前会检查指定 URL 的健康状态(是否可解析和可达)。 即使现有通知目标处于离线状态,MinIO 也不再阻止添加新的通知目标。

Auth Token

必需

MINIO_NOTIFY_WEBHOOK_AUTH_TOKEN

适用于该端点的相应类型的身份验证令牌。 对于不需要身份验证的端点,请省略此项。

为了支持多种令牌类型,MinIO 使用该值创建请求认证标头严格按照指定要求根据端点不同,您可能需要包含额外信息。

例如,对于 Bearer token,在前面加上Bearer:

export MINIO_NOTIFY_WEBHOOK_AUTH_TOKEN_myendpoint="Bearer 1a2b3c4f5e"

根据端点要求修改该值。 自定义身份验证格式可能类似于以下形式:

export MINIO_NOTIFY_WEBHOOK_AUTH_TOKEN_xyz="ServiceXYZ 1a2b3c4f5e"

有关更多详细信息,请查阅所需服务的文档。

notify_webhook auth_token

适用于该端点的相应类型的身份验证令牌。 对于不需要身份验证的端点,请省略此项。

为了支持多种令牌类型,MinIO 使用该值创建请求认证标头严格按照指定要求根据端点不同,您可能需要包含额外信息。

例如,对于 Bearer token,在前面加上Bearer:

   mc admin config set myminio notify_webhook   \
   endpoint="https://webhook-1.example.net"  \
      auth_token="Bearer 1a2b3c4f5e"

根据端点要求修改该值。 自定义身份验证格式可能类似于以下形式:

   mc admin config set myminio notify_webhook   \
      endpoint="https://webhook-1.example.net"  \
      auth_token="ServiceXYZ 1a2b3c4f5e"

有关更多详细信息,请查阅所需服务的文档。

在版本 RELEASE.2023-06-23T20-26-00Z 中更改。

MinIO 在作为部分结果返回时会遮蔽此值mc admin config get.

队列目录

可选

MINIO_NOTIFY_WEBHOOK_QUEUE_DIR
notify_webhook queue_dir

指定目录路径以启用 MinIO 的持久化事件存储,用于存放未送达的消息,例如/opt/minio/events.

MinIO 在 webhook 服务离线期间将未送达的事件存储在指定存储中,并在连接恢复时重放已存储的事件。

队列限制

可选

MINIO_NOTIFY_WEBHOOK_QUEUE_LIMIT
notify_webhook queue_limit

指定未送达消息的最大限制。 默认值为100000.

客户端证书

可选

MINIO_NOTIFY_WEBHOOK_CLIENT_CERT
notify_webhook client_cert

指定用于对 webhook 服务执行 mTLS 身份验证的客户端证书路径。

客户端密钥

可选

MINIO_NOTIFY_WEBHOOK_CLIENT_KEY
notify_webhook client_key

指定客户端私钥的路径,用于对 Webhook 服务执行 mTLS 身份验证。