触发器(Webhook)

容器镜像服务KCR支持配置并使用触发器（Webhook）功能，允许您自定义创建触发器规则，并支持查看触发日志。当触发动作发生时，自动执行您自定义的POST请求。

创建触发器

1. 登录容器镜像服务控制台。
2. 在顶部菜单栏，选择所需地域。
3. 在实例列表页面单击目标容器镜像服务实例。
4. 在容器镜像服务实例管理页面左侧导航栏选择仓库管理 > 触发器。
5. 在触发器列表页单击创建触发器。
6. 在新建触发器弹窗中配置相关信息，如下图所示：
   
   • 名称：触发器名称，2-256个字符，支持小写字母，数字，及 “- . _” 三种符号，且以字母数字开头。
   • 触发动作：目前支持推送镜像、删除镜像。

     注：若您选择删除镜像为触发动作，当您删除镜像tag时不会触发请求。

   • 触发规则：触发器生效的命名空间。
   • URL：触发器被触发后，发起请求的 URL地址。触发器将向该 URL 地址发起 POST 请求，请求 body 中将包含触发动作、触发规则等信息。
   • Header：触发器发起 POST 请求时，支持以 Key:Value 形式输入可携带的 Header 信息。
7. 单击确认即可完成创建触发器。

触发器相关操作

触发器创建成功后，即可进行查看触发记录以及修改、删除触发器等操作。

修改触发器状态

表示触发器启用，表示触发器禁用。

查看触发记录

单击指定触发器名称右侧的触发记录即可查看该规则触发日志。

修改触发器

重新配置触发器信息，注：触发规则中命名空间不可更改。

删除触发器

删除该触发器规则。

相关信息

Webhook请求格式参考

当您对符合触发的规则执行相应动作时，例如向指定镜像仓库推送新的镜像版本时，则相应的触发器将被触发，并向触发规则中配置的URL发起HTTP POST请求，请求Body中包含触发动作、仓库路径等信息。以下为推送镜像触发后并经解析的请求Body信息，可供开发Webhook服务端参考：

{
  "type": "PUSH_ARTIFACT",
  "occur_at": xxxxxxxx,
  "event_data": {
    "resources": [
      {
        "digest": "sha256:xxxxxxxxxxxx",
        "tag": "v1",
        "resource_url": "xxxxxx/xxxxxx/nginx:v1"
      }
    ],
    "repository": {
      "date_created": xxxxxx,
      "name": "nginx",
      "namespace": "xxxxxx",
      "repo_full_name": "xxxxxx/nginx",
      "repo_type": "public"
    }
  },
  "operator": "xxxxxxxxxx"
}