超实用Apache Druid REST API指南：从入门到精通的端点与参数解析

在现代数据处理中，实时分析数据库（Real-time Analytics Database）扮演着关键角色。Apache Druid作为一款高性能的实时分析数据库，提供了丰富的REST API接口，让用户能够轻松实现数据查询、任务管理、集群监控等核心功能。然而，面对众多的API端点和参数，很多用户常常感到困惑，不知道如何高效利用这些接口来满足自己的业务需求。本文将为您详细介绍Apache Druid的REST API，帮助您快速掌握各个端点的功能和参数使用方法，让您的数据分析工作更加得心应手。读完本文，您将能够熟练使用Druid的REST API进行数据查询、任务管理、集群监控等操作，提升数据处理效率。

API概览

Apache Druid的REST API涵盖了多个方面，包括HTTP API和Java API。其中，HTTP API是用户最常用的接口，提供了丰富的功能。

HTTP API

HTTP API包含了众多端点，用于实现数据查询、任务管理、数据管理等功能。以下是一些主要的HTTP API端点：

• Druid SQL queries：用于提交SQL查询。
• SQL-based ingestion：提交基于SQL的批量摄入请求。
• JSON querying：提交基于JSON的原生查询。
• Tasks：管理数据摄入操作。
• Supervisors：管理数据摄入生命周期和数据处理的监督器。
• Retention rules：定义和管理跨数据源的数据保留规则。
• Data management：管理数据段。
• Automatic compaction：摄入后优化段大小。
• Lookups：管理和修改键值数据源。
• Service status：监控Druid集群中的组件。
• Dynamic configuration：配置协调器和霸主进程的行为。
• Legacy metadata：检索数据源元数据。

Java API

Java API主要提供了SQL JDBC驱动，用于连接Druid并使用Avatica JDBC驱动进行Druid SQL查询，具体可参考SQL JDBC driver。

常用API详解

SQL查询API

提交查询

该端点用于提交SQL查询，请求体为JSON格式，包含查询语句、结果格式等参数。

• URL：POST /druid/v2/sql
• 请求体参数：
  • query：SQL查询字符串。
  • resultFormat：结果格式，可选值有object、array、objectLines、arrayLines、csv。
  • header：是否返回列名信息，布尔值。
  • typesHeader：是否返回Druid运行时类型信息，布尔值，需header为true。
  • sqlTypesHeader：是否返回SQL类型信息，布尔值，需header为true。
  • context：包含可选的SQL查询上下文参数的JSON对象。
  • parameters：参数化查询的参数列表。

以下是一个使用cURL提交查询的示例：

curl "http://ROUTER_IP:ROUTER_PORT/druid/v2/sql" \
--header 'Content-Type: application/json' \
--data '{
    "query": "SELECT * FROM wikipedia WHERE user='\''BlueMoon2662'\''",
    "context" : {"sqlQueryId" : "request01"},
    "header" : true,
    "typesHeader" : true,
    "sqlTypesHeader" : true
}'

取消查询

用于取消正在执行的查询，需要查询ID。

• URL：DELETE /druid/v2/sql/{sqlQueryId}

任务管理API

获取任务列表

可获取集群中所有任务的数组，支持按状态、数据源等参数过滤。

• URL：GET /druid/indexer/v1/tasks
• 查询参数：
  • state：任务状态，可选值有running、complete、waiting、pending。
  • datasource：按数据源过滤。
  • createdTimeInterval：创建时间间隔，ISO-8601格式，用_分隔。
  • max：返回的最大任务数，仅对complete状态有效。
  • type：任务类型。

示例：

curl "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/tasks/?state=complete&datasource=wikipedia_api&createdTimeInterval=2015-09-12_2015-09-13&max=10&type=query_worker"

获取任务状态

根据任务ID获取任务状态。

• URL：GET /druid/indexer/v1/task/{taskId}/status

数据管理API

标记段为未使用

将指定数据源的特定段标记为未使用。

• URL：DELETE /druid/coordinator/v1/datasources/{datasource}/segments/{segmentId}

永久删除段

发送kill任务，永久删除指定数据源和时间间隔内未使用段的元数据并从深度存储中移除它们。

• URL：DELETE /druid/coordinator/v1/datasources/{datasource}/intervals/{interval}

集群监控API

获取服务状态

获取单个服务的信息，包括Druid版本、加载的扩展、内存使用等。

• URL：GET /status

获取服务健康状态

检查服务是否在线，返回布尔值true表示服务可接收API调用。

• URL：GET /status/health

API使用示例

示例1：使用SQL API查询数据

curl "http://localhost:8888/druid/v2/sql" \
--header 'Content-Type: application/json' \
--data '{
    "query": "SELECT COUNT(*) FROM wikipedia",
    "resultFormat": "object",
    "header": true
}'

示例2：获取任务列表

curl "http://localhost:8888/druid/indexer/v1/tasks?state=running"

总结与展望

Apache Druid的REST API为用户提供了强大的功能，涵盖了数据查询、任务管理、集群监控等各个方面。通过本文的介绍，您已经了解了Druid REST API的概览、常用API的详细信息以及使用示例。在实际应用中，您可以根据自己的业务需求，灵活运用这些API来实现数据处理和分析任务。

未来，随着Druid的不断发展，REST API也将不断完善和扩展，为用户提供更加丰富和便捷的功能。建议您持续关注Druid的官方文档，以获取最新的API信息和使用技巧。

如果您觉得本文对您有帮助，请点赞、收藏并关注我们，以便获取更多关于Apache Druid的优质内容。下期我们将为您带来Druid数据摄入的最佳实践，敬请期待！