如何使用REST API从命令行触发TeamCity构建？

要使用REST API从命令行触发TeamCity构建，您需要执行以下步骤：

基础概念

REST（Representational State Transfer）是一种用于分布式系统中的软件架构风格。它依赖于无状态、客户端-服务器、可缓存的通信协议——HTTP协议。REST API允许您通过HTTP请求与TeamCity服务器进行交互，触发构建任务。

类型

GET：用于获取资源。
POST：用于创建资源。
PUT：用于更新资源。
DELETE：用于删除资源。

应用场景

自动化构建触发。
集成CI/CD流程。
远程管理TeamCity服务器。

如何使用REST API从命令行触发TeamCity构建

步骤1：获取触发构建的URL

首先，您需要知道TeamCity服务器的URL和项目ID，以及构建配置ID。假设TeamCity服务器的URL为https://yourteamcityserver.com，项目ID为ProjectID，构建配置ID为BuildConfigID。

步骤2：构造HTTP POST请求

您需要构造一个HTTP POST请求来触发构建。请求的URL格式如下：

https://yourteamcityserver.com/app/rest/buildTypes/id:BuildConfigID/start

步骤3：使用命令行工具发送请求

您可以使用curl命令行工具来发送HTTP POST请求。以下是一个示例命令：

curl -X POST "https://yourteamcityserver.com/app/rest/buildTypes/id:BuildConfigID/start" \
     -H "Content-Type: application/json" \
     -H "Authorization: Basic YOUR_BASE64_ENCODED_CREDENTIALS" \
     -d '{"buildTypeId":"id:BuildConfigID","properties":{"property1":"value1"}}'

-X POST：指定HTTP方法为POST。
-H "Content-Type: application/json"：设置请求头，指定内容类型为JSON。
-H "Authorization: Basic YOUR_BASE64_ENCODED_CREDENTIALS"：设置认证信息，YOUR_BASE64_ENCODED_CREDENTIALS是您的用户名和密码的Base64编码。
-d '{"buildTypeId":"id:BuildConfigID","properties":{"property1":"value1"}}'：设置请求体，包含构建类型ID和任何需要的属性。

示例代码

以下是一个完整的示例代码，展示了如何使用Python的requests库来触发TeamCity构建：

import requests
import base64

# 设置TeamCity服务器URL、项目ID、构建配置ID和认证信息
teamcity_url = "https://yourteamcityserver.com"
project_id = "ProjectID"
build_config_id = "BuildConfigID"
username = "your_username"
password = "your_password"

# 编码认证信息
credentials = base64.b64encode(f"{username}:{password}".encode()).decode()

# 构造请求URL
url = f"{teamcity_url}/app/rest/buildTypes/id:{build_config_id}/start"

# 构造请求头
headers = {
    "Content-Type": "application/json",
    "Authorization": f"Basic {credentials}"
}

# 构造请求体
data = {
    "buildTypeId": f"id:{build_config_id}",
    "properties": {
        "property1": "value1"
    }
}

# 发送POST请求
response = requests.post(url, headers=headers, json=data)

# 检查响应
if response.status_code == 200:
    print("Build triggered successfully.")
else:
    print(f"Failed to trigger build. Status code: {response.status_code}")
    print(response.json())