Buildkite API 服务器文档

功能概述

这个服务器提供了一系列与 Buildkite 平台交互的接口，允许您执行各种操作，如检索构建信息、重试作业等。以下是所有可用接口的详细说明。

接口列表

1. 检索构建信息

接口名称: /build-info
请求方法: GET
参数: build_url (必填)
响应: 返回指定构建的详细信息，包括作业状态和失败信息。

2. 重试作业

接口名称: /retry-job
请求方法: POST
请求体:

{
  "organization": "my-org",
  "pipeline": "my-pipeline", 
  "build_number": 123,
  "job_id": "01234567-89ab-cdef-0123-456789abcdef",
  "access_token": "your-token"
}

响应: 返回重试作业的状态。

3. 检索构建失败信息

接口名称: /build-failures
请求方法: POST
请求体:

{
  "organization": "my-org",
  "pipeline": "my-pipeline", 
  "state": "finished",
  "per_page": 10,
  "page": 1,
  "access_token": "your-token"
}

响应: 返回指定管道中失败构建的列表，包括每个构建的作业信息。

环境变量

• BUILDKITE_ACCESS_TOKEN: 您的 Buildkite API令牌，具有读取权限
• PORT (可选): 服务器运行的端口（默认: 63330）

错误处理

服务器在出现错误时返回适当的 HTTP 状态码和错误消息：

• 400: 请求错误 - 缺少或无效参数
• 401: 未授权 - 无效或缺少访问令牌
• 404: 资源未找到
• 500: 服务器内部错误