2.23. Trigger
创建、列出和管理构建触发器。
2.23.1. activateBuildTrigger 复制链接链接已复制到粘贴板!
激活指定的构建触发器。
POST /api/v1/repository/{repository}/trigger/{trigger_uuid}/activate
授权: oauth2_implicit (repo:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
软件仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
path |
trigger_uuid | 构建触发器的 UUID | 字符串 |
请求正文模式(application/json)
名称 | 描述 | 模式 |
---|---|---|
config | 任意 json。 | 对象 |
pull_robot | 用于拉取镜像的机器人名称。 | 字符串 |
响应
2.23.2. listTriggerRecentBuilds 复制链接链接已复制到粘贴板!
列出由指定触发器启动的构建。
GET /api/v1/repository/{repository}/trigger/{trigger_uuid}/builds
授权: oauth2_implicit (repo:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
软件仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
path |
trigger_uuid | 构建触发器的 UUID | 字符串 |
查询参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
query |
limit | 要返回的最大构建数 | 整数 |
响应
2.23.3. manuallyStartBuildTrigger 复制链接链接已复制到粘贴板!
从指定的触发器手动启动构建。
POST /api/v1/repository/{repository}/trigger/{trigger_uuid}/start
授权: oauth2_implicit (repo:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
软件仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
path |
trigger_uuid | 构建触发器的 UUID | 字符串 |
请求正文模式(application/json)
激活构建触发器的可选 run 参数
名称 | 描述 | 模式 |
---|---|---|
branch_name | (仅为SCM 指定,则要构建的分支的名称。 | 字符串 |
commit_sha | (仅自定义)如果指定,则使用 ref/SHA1 签出 git 存储库。 | 字符串 |
refs | (仅限SCM 指定,则需要构建 ref。 |
响应
2.23.4. getBuildTrigger 复制链接链接已复制到粘贴板!
获取指定构建触发器的信息。
GET /api/v1/repository/{repository}/trigger/{trigger_uuid}
授权: oauth2_implicit (repo:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
软件仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
path |
trigger_uuid | 构建触发器的 UUID | 字符串 |
响应
2.23.5. updateBuildTrigger 复制链接链接已复制到粘贴板!
更新指定的构建触发器。
PUT /api/v1/repository/{repository}/trigger/{trigger_uuid}
授权: oauth2_implicit (repo:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
软件仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
path |
trigger_uuid | 构建触发器的 UUID | 字符串 |
请求正文模式(application/json)
更新构建触发器的选项
名称 | 描述 | 模式 |
---|---|---|
启用 | 是否启用构建触发器 | 布尔值 |
响应
2.23.6. deleteBuildTrigger 复制链接链接已复制到粘贴板!
删除指定的构建触发器。
DELETE /api/v1/repository/{repository}/trigger/{trigger_uuid}
授权: oauth2_implicit (repo:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
软件仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |
path |
trigger_uuid | 构建触发器的 UUID | 字符串 |
响应
2.23.7. listBuildTriggers 复制链接链接已复制到粘贴板!
列出指定存储库的触发器。
GET /api/v1/repository/{repository}/trigger/
授权: oauth2_implicit (repo:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
软件仓库 | 存储库的完整路径。例如 namespace/name | 字符串 |