API 说明文档

# Cloudflare API 集成 使用 Cloudflare REST API 的指南 - 包括认证、SDK 使用、常见模式和故障排除。 ## 快速决策树 你如何调用 Cloudflare API？ ├─ 从 Workers 运行时 → 使用绑定，而非 REST API (见 ../bindings/) ├─ 服务端 (Node/Python/Go) → 官方 SDK (见 api.md) ├─ CLI/脚本 → Wrangler 或 curl (见 configuration.md) ├─ 基础设施即代码 → 见 ../pulumi/ 或 ../terraform/ └─ 一次性请求 → curl 示例 (见 api.md) ## SDK 选择 | 语言 | 包 | 适用场景 | 默认重试次数 | |----------|---------|----------|-----------------| | TypeScript | `cloudflare` | Node.js, Bun, Next.js, Workers | 2 | | Python | `cloudflare` | FastAPI, Django, 脚本 | 2 | | Go | `cloudflare-go/v4` | CLI 工具, 微服务 | 10 | 所有 SDK 均由 Stainless 基于 OpenAPI 规范生成（API 一致性高）。 ## 认证方式 | 方法 | 安全性 | 适用场景 | 范围 | |--------|----------|----------|-------| | **API Token** ✓ | 有范围限制，可轮换 | 生产环境 | 区域或账户级 | | API Key + Email | 完全账户访问权限 | 仅限旧版 | 全部 | | User Service Key | 受限 | 仅限源站 CA 证书 | 源站 CA | 新项目**请始终使用 API Token**。 ## 速率限制 | 限制 | 数值 | |-------|-------| | 每个用户/Token | 1200 次请求 / 5 分钟 | | 每个 IP | 200 次请求 / 秒 | | GraphQL | 320 / 5 分钟 (基于成本) | ## 阅读顺序 | 任务 | 需阅读文件 | |------|---------------| | 初始化 SDK 客户端 | api.md | | 配置认证/超时/重试 | configuration.md | | 查找使用模式 | patterns.md | | 调试错误/速率限制 | gotchas.md | | 产品特定 API | ../workers/, ../r2/, ../kv/ 等 | ## 本参考文档内容 - **[api.md](api.md)** - SDK 客户端初始化、分页、错误处理、示例 - **[configuration.md](configuration.md)** - 环境变量、SDK 配置、Wrangler 设置 - **[patterns.md](patterns.md)** - 实际应用模式、批量操作、工作流 - **[gotchas.md](gotchas.md)** - 速率限制、SDK 特定问题、故障排除 ## 另请参阅 - [Cloudflare API 文档](https://developers.cloudflare.com/api/) - [绑定参考](../bindings/) - Workers 运行时绑定（优先于 REST API） - [Wrangler 参考](../wrangler/) - Cloudflare 开发的 CLI 工具