Webhook 服务通知设置
此页面记录了将 Webhook 服务配置为 存储桶通知 目标的设置。请参阅 将事件发布到 Webhook,了解有关使用这些设置的教程。
您可以通过定义以下内容来建立或修改设置
在启动或重新启动 MinIO 服务器之前,在主机系统上定义一个环境变量。请参阅您操作系统的文档,了解如何定义环境变量。
使用
mc admin config set定义一个配置设置。使用 MinIO 控制台的管理员 > 设置 页面定义一个配置设置。
如果您同时定义了环境变量和类似的配置设置,MinIO 将使用环境变量的值。
某些设置仅具有环境变量或配置设置,而不是两者兼而有之。
重要
每个配置设置都控制着 MinIO 的基本行为和功能。MinIO **强烈建议**在将配置更改应用于生产环境之前,先在较低的环境(例如 DEV 或 QA)中进行测试。
多个 Webhook 服务目标
您可以通过为每个相关的 Webhook 设置集附加一个唯一的标识符 _ID 到顶级键来指定多个 Webhook 服务端点。例如,以下命令将两个不同的 Webhook 服务端点分别设置为 PRIMARY 和 SECONDARY
set MINIO_NOTIFY_WEBHOOK_ENABLE_PRIMARY="on"
set MINIO_NOTIFY_WEBHOOK_ENDPOINT_PRIMARY="https://webhook1.example.net"
set MINIO_NOTIFY_WEBHOOK_ENABLE_SECONDARY="on"
set 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 存储桶通知 的 Webhook 服务端点的顶级配置键。
使用mc admin config set 设置或更新 Webhook 服务端点。每个目标都需要endpoint 参数。将其他可选参数指定为以空格 (" ") 分隔的列表。
mc admin config set notify_webhook \
endpoint="https://webhook.example.net"
[ARGUMENT="VALUE"] ... \
端点
必需
指定 Webhook 服务的 URL。
版本 RELEASE.2023-05-27T05-56-19Z 中已更改: 在添加目标之前,MinIO 会检查指定 URL 的运行状况(如果可解析且可访问)。如果现有目标处于脱机状态,MinIO 不会再阻止添加新的通知目标。
身份验证令牌
必需
适用于端点的相应类型的身份验证令牌。对于不需要身份验证的端点,请省略。
为了允许各种类型的令牌,MinIO 使用完全按照指定的值创建请求身份验证标头。根据端点的不同,您可能需要包含其他信息。
例如,对于 Bearer 令牌,请在前面加上Bearer
set MINIO_NOTIFY_WEBHOOK_AUTH_TOKEN_myendpoint="Bearer 1a2b3c4f5e"
根据端点要求修改值。自定义身份验证格式可能类似于以下内容
set MINIO_NOTIFY_WEBHOOK_AUTH_TOKEN_xyz="ServiceXYZ 1a2b3c4f5e"
请参阅所需服务的文档以获取更多详细信息。
- notify_webhook auth_token
适用于端点的相应类型的身份验证令牌。对于不需要身份验证的端点,请省略。
为了允许各种类型的令牌,MinIO 使用完全按照指定的值创建请求身份验证标头。根据端点的不同,您可能需要包含其他信息。
例如,对于 Bearer 令牌,请在前面加上
Bearermc 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 中已更改。
当作为
mc admin config get的一部分返回时,MinIO 会删除此值。
队列目录
可选
指定目录路径以启用 MinIO 的持久事件存储,用于未送达的消息,例如/opt/minio/events。
当 Webhook 服务脱机时,MinIO 会将未送达的事件存储在指定的存储中,并在连接恢复时重播存储的事件。
队列限制
可选
指定未送达消息的最大限制。默认为100000。
客户端证书
可选
指定用于对 Webhook 服务执行 mTLS 身份验证的客户端证书的路径。
客户端密钥
可选
指定用于对 Webhook 服务执行 mTLS 身份验证的客户端私钥的路径。
最大重试次数
可选
重试发送事件的最大尝试次数。默认情况下,最大重试次数设置为0。
重试间隔
可选
两次重试尝试之间等待的时间长度。默认值为3s。
注释
可选
指定与 Webhook 配置关联的注释。