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
required

构建触发器的 UUID

字符串

请求正文模式(application/json)
名称描述模式

config
optional

任意 json。

对象

pull_robot
optional

用于拉取镜像的机器人名称。

字符串

响应
HTTP 代码描述模式

201

成功创建

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.23.2. listTriggerRecentBuilds

列出由指定触发器启动的构建。

GET /api/v1/repository/{repository}/trigger/{trigger_uuid}/builds

授权: oauth2_implicit (repo:admin)

路径参数
类型Name描述模式

path

软件仓库
必需

存储库的完整路径。例如 namespace/name

字符串

path

trigger_uuid
required

构建触发器的 UUID

字符串

查询参数
类型Name描述模式

query

limit
optional

要返回的最大构建数

整数

响应
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.23.3. manuallyStartBuildTrigger

从指定的触发器手动启动构建。

POST /api/v1/repository/{repository}/trigger/{trigger_uuid}/start

授权: oauth2_implicit (repo:admin)

路径参数
类型Name描述模式

path

软件仓库
必需

存储库的完整路径。例如 namespace/name

字符串

path

trigger_uuid
required

构建触发器的 UUID

字符串

请求正文模式(application/json)

激活构建触发器的可选 run 参数

名称描述模式

branch_name
optional

(仅为SCM 指定,则要构建的分支的名称。

字符串

commit_sha
optional

(仅自定义)如果指定,则使用 ref/SHA1 签出 git 存储库。

字符串

refs
可选

(仅限SCM 指定,则需要构建 ref。

 
响应
HTTP 代码描述模式

201

成功创建

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.23.4. getBuildTrigger

获取指定构建触发器的信息。

GET /api/v1/repository/{repository}/trigger/{trigger_uuid}

授权: oauth2_implicit (repo:admin)

路径参数
类型Name描述模式

path

软件仓库
必需

存储库的完整路径。例如 namespace/name

字符串

path

trigger_uuid
required

构建触发器的 UUID

字符串

响应
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.23.5. updateBuildTrigger

更新指定的构建触发器。

PUT /api/v1/repository/{repository}/trigger/{trigger_uuid}

授权: oauth2_implicit (repo:admin)

路径参数
类型Name描述模式

path

软件仓库
必需

存储库的完整路径。例如 namespace/name

字符串

path

trigger_uuid
required

构建触发器的 UUID

字符串

请求正文模式(application/json)

更新构建触发器的选项

名称描述模式

启用
可选

是否启用构建触发器

布尔值

响应
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.23.6. deleteBuildTrigger

删除指定的构建触发器。

DELETE /api/v1/repository/{repository}/trigger/{trigger_uuid}

授权: oauth2_implicit (repo:admin)

路径参数
类型Name描述模式

path

软件仓库
必需

存储库的完整路径。例如 namespace/name

字符串

path

trigger_uuid
required

构建触发器的 UUID

字符串

响应
HTTP 代码描述模式

204

已删除

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.23.7. listBuildTriggers

列出指定存储库的触发器。

GET /api/v1/repository/{repository}/trigger/

授权: oauth2_implicit (repo:admin)

路径参数
类型Name描述模式

path

软件仓库
必需

存储库的完整路径。例如 namespace/name

字符串

响应
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError