File size: 10,866 Bytes
32e4bbf |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 |
# Cloudflare API - curl 命令参考
## ✅ 认证方式已验证
提供的凭据使用 **API Key** 认证方式(不是 API Token):
```bash
-H "X-Auth-Email: exslym@closedbyme.com"
-H "X-Auth-Key: 21f3fb278a15b732a4f52c95d5042d78d1a21"
```
**Account ID**: `af2863fcfbc1f170e5ef3b7a648c417d`
---
## 📋 基础命令
### 环境变量设置
```bash
export EMAIL="exslym@closedbyme.com"
export API_KEY="21f3fb278a15b732a4f52c95d5042d78d1a21"
export ACCOUNT_ID="af2863fcfbc1f170e5ef3b7a648c417d"
```
---
## 🏢 账号管理
### 1. 获取账号信息
```bash
curl -X GET "https://api.cloudflare.com/client/v4/accounts" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY" \
-H "Content-Type: application/json"
```
**返回值**:
```json
{
"success": true,
"result": [
{
"id": "af2863fcfbc1f170e5ef3b7a648c417d",
"name": "Exslym@closedbyme.com's Account"
}
]
}
```
---
## 📦 Pages 项目管理
### 1. 列出所有 Pages 项目
```bash
curl -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pages/projects" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY"
```
**简化输出**:
```bash
curl -s -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pages/projects" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY" | jq -r '.result[] | "\(.name) - https://\(.subdomain)"'
```
### 2. 创建 Pages 项目
```bash
curl -X POST "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pages/projects" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "my-new-project",
"production_branch": "main"
}'
```
**实测成功示例**:
```bash
# 创建测试项目
curl -X POST "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pages/projects" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "curl-test-project", "production_branch": "main"}'
```
### 3. 获取特定项目信息
```bash
PROJECT_NAME="diyiciapiceshi13"
curl -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pages/projects/$PROJECT_NAME" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY"
```
### 4. 删除 Pages 项目
```bash
PROJECT_NAME="my-project"
curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pages/projects/$PROJECT_NAME" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY"
```
---
## 🚀 部署管理
### 1. 列出项目部署
```bash
PROJECT_NAME="diyiciapiceshi13"
curl -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pages/projects/$PROJECT_NAME/deployments" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY"
```
**查看最新部署**:
```bash
curl -s -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pages/projects/$PROJECT_NAME/deployments" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY" | jq -r '.result[0] | "URL: \(.url)\n状态: \(.latest_stage.name)"'
```
### 2. 部署文件到 Pages
```bash
PROJECT_NAME="my-project"
# 使用 multipart/form-data 上传文件
curl -X POST "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pages/projects/$PROJECT_NAME/deployments" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY" \
-F "manifest={}" \
-F "branch=main" \
-F "_worker.js=@./_worker.js"
```
**Python 脚本部署示例**(用户提供的成功脚本):
```python
files = {
'manifest': (None, '{}'),
'branch': (None, 'main'),
'_worker.js': ('_worker.js', worker_content, 'text/javascript'),
}
response = requests.post(url, headers=headers, files=files)
```
### 3. 获取部署详情
```bash
PROJECT_NAME="my-project"
DEPLOYMENT_ID="6387f5d9"
curl -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pages/projects/$PROJECT_NAME/deployments/$DEPLOYMENT_ID" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY"
```
---
## 🌐 Zone (域名) 管理
### 1. 列出所有 Zones
```bash
curl -X GET "https://api.cloudflare.com/client/v4/zones" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY"
```
**简化输出**:
```bash
curl -s -X GET "https://api.cloudflare.com/client/v4/zones" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY" | jq -r '.result[] | "\(.name) - \(.status)"'
```
### 2. 创建 Zone(添加域名)
```bash
curl -X POST "https://api.cloudflare.com/client/v4/zones" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"account": {
"id": "'$ACCOUNT_ID'"
},
"name": "example.com",
"type": "full"
}'
```
**获取 Nameservers**:
```bash
curl -s -X POST "https://api.cloudflare.com/client/v4/zones" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"account": {"id": "'$ACCOUNT_ID'"},
"name": "example.com",
"type": "full"
}' | jq -r '.result.name_servers[]'
```
### 3. 获取 Zone 详情
```bash
ZONE_ID="your-zone-id"
curl -X GET "https://api.cloudflare.com/client/v4/zones/$ZONE_ID" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY"
```
### 4. 查看 Nameservers
```bash
ZONE_ID="your-zone-id"
curl -s -X GET "https://api.cloudflare.com/client/v4/zones/$ZONE_ID" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY" | jq -r '.result.name_servers[]'
```
### 5. 删除 Zone
```bash
ZONE_ID="your-zone-id"
curl -X DELETE "https://api.cloudflare.com/client/v4/zones/$ZONE_ID" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY"
```
---
## 🔗 域名绑定
### 1. 绑定域名到 Pages 项目
```bash
PROJECT_NAME="my-project"
DOMAIN_NAME="example.com"
curl -X POST "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pages/projects/$PROJECT_NAME/domains" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "'$DOMAIN_NAME'"
}'
```
### 2. 列出项目的域名
```bash
PROJECT_NAME="my-project"
curl -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pages/projects/$PROJECT_NAME/domains" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY"
```
### 3. 获取域名状态
```bash
PROJECT_NAME="my-project"
DOMAIN_NAME="example.com"
curl -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pages/projects/$PROJECT_NAME/domains/$DOMAIN_NAME" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY"
```
### 4. 删除项目域名
```bash
PROJECT_NAME="my-project"
DOMAIN_NAME="example.com"
curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pages/projects/$PROJECT_NAME/domains/$DOMAIN_NAME" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY"
```
---
## ⚡ Worker 路由
### 1. 创建 Worker 路由
```bash
ZONE_ID="your-zone-id"
curl -X POST "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/workers/routes" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"pattern": "example.com/api/*",
"script": "my-worker-script"
}'
```
### 2. 列出 Worker 路由
```bash
ZONE_ID="your-zone-id"
curl -X GET "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/workers/routes" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY"
```
### 3. 添加 Worker 自定义域名
```bash
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/workers/domains" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"hostname": "api.example.com",
"service": "my-worker",
"zone_id": "your-zone-id",
"environment": "production"
}'
```
### 4. 删除 Worker 路由
```bash
ZONE_ID="your-zone-id"
ROUTE_ID="route-id"
curl -X DELETE "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/workers/routes/$ROUTE_ID" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY"
```
---
## 🛠️ 实用技巧
### 1. 美化 JSON 输出
使用 `jq` 格式化输出:
```bash
curl -s ... | jq '.'
```
### 2. 只看成功状态
```bash
curl -s ... | jq -r '.success'
```
### 3. 提取特定字段
```bash
# 提取项目名称
curl -s ... | jq -r '.result[].name'
# 提取 Nameservers
curl -s ... | jq -r '.result.name_servers[]'
```
### 4. 保存响应到文件
```bash
curl ... > response.json
```
### 5. 显示 HTTP 状态码
```bash
curl -w "\nHTTP Status: %{http_code}\n" ...
```
---
## 🧪 测试脚本
运行完整测试:
```bash
./curl_tests.sh
```
或查看测试脚本内容:
```bash
cat curl_tests.sh
```
---
## 📚 完整工作流示例
### 示例 1: 创建并部署 Pages 项目
```bash
# 1. 创建项目
curl -X POST "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pages/projects" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "my-site", "production_branch": "main"}'
# 2. 部署文件
curl -X POST "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pages/projects/my-site/deployments" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY" \
-F "manifest={}" \
-F "branch=main" \
-F "index.html=@./index.html"
# 3. 查看部署状态
curl -s -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pages/projects/my-site/deployments" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY" | jq -r '.result[0] | "URL: \(.url)"'
```
### 示例 2: 添加域名并获取 Nameservers
```bash
# 1. 创建 Zone
RESPONSE=$(curl -s -X POST "https://api.cloudflare.com/client/v4/zones" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"account": {"id": "'$ACCOUNT_ID'"},
"name": "example.com",
"type": "full"
}')
# 2. 提取 Nameservers
echo "$RESPONSE" | jq -r '.result.name_servers[]'
# 3. 绑定域名到 Pages
curl -X POST "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pages/projects/my-site/domains" \
-H "X-Auth-Email: $EMAIL" \
-H "X-Auth-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "example.com"}'
```
---
## ✅ 测试结果
所有 curl 命令已验证通过:
- ✅ 账号信息获取
- ✅ Pages 项目列表
- ✅ Pages 项目创建
- ✅ Pages 项目详情
- ✅ 部署历史查询
- ✅ Zone 列表
- ✅ Zone 创建和 Nameservers
**Account ID**: `af2863fcfbc1f170e5ef3b7a648c417d`
**认证方式**: API Key (X-Auth-Email + X-Auth-Key)
---
## 🔗 相关链接
- [Cloudflare API 文档](https://developers.cloudflare.com/api/)
- [Pages API 文档](https://developers.cloudflare.com/api/operations/pages-project-create-project)
- [认证方式说明](https://developers.cloudflare.com/fundamentals/api/get-started/keys/)
---
**最后更新**: 2024-01-27
**测试状态**: ✅ 全部通过
|