2.24. trigger
创建、列出和管理构建触发器。
2.24.1. activateBuildTrigger
激活指定的构建触发器。
POST /api/v1/repository/{repository}/trigger/{trigger_uuid}/activate
Authorizations: oauth2_implicit(repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
trigger_uuid | 构建触发器的 UUID | 字符串 |
| path |
软件仓库 | 仓库的完整路径。例如 namespace/name | 字符串 |
请求正文模式(application/json)
| 名称 | 描述 | 模式 |
|---|---|---|
|
配置 | 任意 json. | 对象 |
|
pull_robot | 用于拉取镜像的机器机器的名称。 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 201 | 成功创建 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.24.2. listTriggerRecentBuilds
列出由指定触发器启动的构建。
GET /api/v1/repository/{repository}/trigger/{trigger_uuid}/builds
Authorizations: oauth2_implicit(repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
trigger_uuid | 构建触发器的 UUID | 字符串 |
| path |
软件仓库 | 仓库的完整路径。例如 namespace/name | 字符串 |
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
limit | 要返回的最大构建数 | 整数 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.24.3. manuallyStartBuildTrigger
从指定的触发器手动启动构建。
POST /api/v1/repository/{repository}/trigger/{trigger_uuid}/start
Authorizations: oauth2_implicit(repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
trigger_uuid | 构建触发器的 UUID | 字符串 |
| path |
软件仓库 | 仓库的完整路径。例如 namespace/name | 字符串 |
请求正文模式(application/json)
用于激活构建触发器的可选运行参数
| 名称 | 描述 | 模式 |
|---|---|---|
|
branch_name | （仅限 SCM），如果指定，要构建的分支名称。 | 字符串 |
|
commit_sha | （仅自定义）如果指定，则用于签出 git 存储库的 ref/SHA1。 | 字符串 |
|
refs | （仅限 SCM）如果指定，则要构建的 ref。 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 201 | 成功创建 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.24.4. getBuildTrigger
获取指定构建触发器的信息。
GET /api/v1/repository/{repository}/trigger/{trigger_uuid}
Authorizations: oauth2_implicit(repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
trigger_uuid | 构建触发器的 UUID | 字符串 |
| path |
软件仓库 | 仓库的完整路径。例如 namespace/name | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.24.5. updateBuildTrigger
更新指定的构建触发器。
PUT /api/v1/repository/{repository}/trigger/{trigger_uuid}
Authorizations: oauth2_implicit(repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
trigger_uuid | 构建触发器的 UUID | 字符串 |
| path |
软件仓库 | 仓库的完整路径。例如 namespace/name | 字符串 |
请求正文模式(application/json)
更新构建触发器的选项
| 名称 | 描述 | 模式 |
|---|---|---|
|
需要启用 | 是否启用构建触发器 | 布尔值 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.24.6. deleteBuildTrigger
删除指定的构建触发器。
DELETE /api/v1/repository/{repository}/trigger/{trigger_uuid}
Authorizations: oauth2_implicit(repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
trigger_uuid | 构建触发器的 UUID | 字符串 |
| path |
软件仓库 | 仓库的完整路径。例如 namespace/name | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 204 | 已删除 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.24.7. listBuildTriggers
列出指定存储库的触发器。
GET /api/v1/repository/{repository}/trigger/
Authorizations: oauth2_implicit(repo:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
软件仓库 | 仓库的完整路径。例如 namespace/name | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
