SQL API 允许你使用 SQL 查询 Cloudflare 分析和可观测性数据集。使用该 API 可以选择字段、筛选事件、计算聚合、对结果分组,并将分析数据与应用程序集成。
SQL API 在以下地址提供 GET 和 POST 查询端点:
https://api.cloudflare.com/client/v4/analytics/sql每次请求发送一条 SELECT 语句。使用 POST 发送原始 SQL 或带参数、请求级范围和时间范围的 JSON 请求。使用 GET 发送 URL 编码查询。API 会在执行查询前,根据可用数据集和支持的 SQL 语言验证该语句。
使用内省端点发现数据集名称、类别、描述、种类、列和数据类型。也可以使用 cf sql query 运行查询,并使用 cf sql datasets 列出数据集。
SQL API 支持刻意受限的 SQL 方言。它不会将任意 SQL 透传到底层数据存储。完整语言范围请参阅 SQL 语言参考。
每个查询必须包含:
- 在 SQL 语句或请求正文中提供的账户或 zone 范围,用于标识你有权查询的数据。
- 限制查询读取回溯范围的下限时间边界。
- 一个带 schema 限定的数据集,例如
events.httpRequests。
数据集和字段可用性取决于你的 Cloudflare 套餐和权限。API 会授权查询中命名的每个账户或 zone。
请参阅快速入门以创建 API 令牌并运行第一个查询。
要从 Cloudflare Worker 查询数据集而无需管理 API 令牌,请使用 Workers 绑定。