> ## Documentation Index
> Fetch the complete documentation index at: https://docs.siflow.cn/llms.txt
> Use this file to discover all available pages before exploring further.

# 配置镜像仓库 Webhook

> 为镜像仓库项目配置事件回调，并查看 Webhook 投递记录。

Webhook 是容器镜像仓库的事件通知机制。配置 Webhook 后，当项目中的制品发生指定事件时，系统会以 HTTP POST 方式向目标地址发送事件信息。您可以将 Webhook 用于触发 CI/CD 流程、同步外部系统状态、记录审计信息或发送通知。

## 操作前确认

* 已准备可接收 HTTP POST 请求的回调地址（Endpoint）。
* 如回调服务需要鉴权，已准备可用于请求校验的认证 Header。

## 创建 Webhook

1. 登录 [GPU 云服务控制台](https://console.siflow.cn/gpu-cloud/home)。

2. 进入 **存储 > 镜像仓库** 页面，选择项目所在地域。

3. 在 **项目** 页签单击目标项目名称。

4. 在项目侧边栏进入 **Webhook** 页面，单击 **新建 Webhook**。

5. 填写 Webhook 配置。

   | 配置项 | 说明 |
   | - | - |
   | **名称** | 填写便于识别接收系统或用途的名称。 |
   | **描述** | 按需记录回调用途，例如用于镜像同步、审计记录或外部通知。 |
   | **事件类型** | 选择下游系统需要处理的事件。只勾选必要事件，避免外部系统接收无关通知。 |
   | **目标地址** | 填写回调服务的接收地址，并确认该服务可以接收镜像仓库发送的 HTTP POST 请求。 |
   | **鉴权 Header** | 如果回调服务要求请求携带认证头，填写相应信息。不要将密钥写入描述或其他公开内容。 |
   | **证书校验** | 使用 HTTPS 回调地址时，按接收服务的证书配置选择是否校验证书。 |

   **事件类型** 可参考下表选择。不同事件发送给目标地址的回调请求内容不同，通常包含事件类型、发生时间、操作者以及相关仓库或制品信息。

   | 事件 | 事件类型 | 说明 | 主要回调内容 |
   | - | - | - | - |
   | 推送制品到仓库 | `PUSH_ARTIFACT` | 制品被推送到项目中的仓库时触发。 | 命名空间、仓库、资源 URL、标签、清单摘要、制品名称、推送时间、操作者。 |
   | 从仓库拉取制品 | `PULL_ARTIFACT` | 制品被拉取时触发。 | 命名空间、仓库、清单摘要、制品名称、拉取时间、操作者。 |
   | 从仓库删除制品 | `DELETE_ARTIFACT` | 制品被删除时触发。 | 命名空间、仓库、清单摘要、制品名称、制品大小、删除时间、操作者。 |
   | 项目配额超出 | `QUOTA_EXCEED` | 项目配额超出时触发。 | 命名空间、仓库、标签、清单摘要、制品名称、推送时间、操作者。 |
   | 项目配额达到预警阈值 | `QUOTA_WARNING` | 项目配额达到预警阈值时触发。 | 命名空间、仓库、标签、清单摘要、制品名称、推送时间、操作者。 |
   | 制品扫描完成 | `SCANNING_COMPLETED` | 制品扫描任务完成时触发。 该事件表示扫描流程完成，不代表制品没有漏洞。 | 命名空间、仓库、标签、制品名称、漏洞数量、扫描完成时间、执行扫描的用户。 |
   | 制品扫描停止 | `SCANNING_STOPPED` | 制品扫描任务停止或中止时触发。 该事件不代表扫描成功完成。 | 命名空间、仓库、标签、制品名称、扫描状态。 |
   | 制品扫描失败 | `SCANNING_FAILED` | 制品扫描任务失败时触发。 该事件表示扫描未正常完成。 | 命名空间、仓库、标签、制品名称、错误信息、执行扫描的用户。 |
   | 制品复制状态变化 | `REPLICATION` | 制品复制任务状态变化时触发。 | 命名空间、仓库、标签、清单摘要、制品名称、复制状态、操作者。 |
   | 制品标签保留完成 | `TAG_RETENTION` | 制品保留策略执行完成时触发。 | 命名空间、仓库、保留数量、保留规则、已删除制品结果。 |

6. 保存配置，在 **Webhook** 页面确认 Webhook 已创建。

   ![Webhook 列表](https://mintcdn.com/siflow/dUChFiiLy9KdHCra/gpu-cloud/registry/media/image-webhook-list.png?fit=max\&auto=format\&n=dUChFiiLy9KdHCra\&q=85\&s=bb729116d27ac4269c04ed8a8b9c9f27)

## 查看投递记录

1. 在 **Webhook** 页面找到目标 Webhook，单击展开图标。

2. 查看投递记录。

   **载荷** 是 Webhook 实际发送给目标地址的事件内容。如果外部系统未收到回调，先核对 Webhook 是否已启用、事件类型是否匹配、目标地址是否可用，以及接收服务是否能处理当前事件内容。

   ![Webhook 投递记录](https://mintcdn.com/siflow/dUChFiiLy9KdHCra/gpu-cloud/registry/media/image-webhook-records.png?fit=max\&auto=format\&n=dUChFiiLy9KdHCra\&q=85\&s=8ededdc59ebcf2c45eb799b90f235b54)

## 更新或停用 Webhook

* 需要修改目标地址、事件类型或认证信息时，在目标 Webhook 的 **操作** 列单击 **编辑**，修改后保存。
* 需要暂停发送事件通知时，单击 **禁用**。停用后，该 Webhook 不再向目标地址投递事件。
* 不再需要该 Webhook 时，单击 **删除** 并按提示确认。删除前，请确认下游系统不再依赖对应事件通知。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.