跳转到主要内容

HugeGraph RESTful API

⚠️ 版本兼容性说明

  • 当前 API 的图资源路径以 /graphspaces/{graphspace}/graphs/{graph} 开头。
  • HugeGraph 1.5.x 及更早版本使用 /graphs/{graph}。创建、克隆图等接口的请求格式也与当前版本不同。
  • 默认图空间名是 DEFAULT
  • 旧版本 doc 参考:HugeGraph 1.5.x RESTful API

Server 启动后,可访问 http://localhost:8080/swagger-ui/index.html 查看当前版本的 OpenAPI 页面。使用示例

Graphs(图管理)REST 接口:管理图实例的生命周期,包括创建、查询、克隆、清空和删除图数据库。

Graphspace(图空间)REST 接口:多租户与资源隔离的创建、查看、更新与删除,以及使用前置条件与限制。

Authentication(认证鉴权)REST 接口:管理用户、角色、权限和访问控制,实现细粒度的图数据安全机制。

Schema(图模式)REST 接口:查询图的完整模式定义,包括属性键、顶点标签、边标签和索引标签的统一视图。

PropertyKey(属性键)REST 接口:定义图中所有属性的数据类型和基数约束,是构建图模式的基础元素。

VertexLabel(顶点标签)REST 接口:定义顶点类型、ID策略及关联的属性,决定顶点的结构和约束规则。

EdgeLabel(边标签)REST 接口:定义边类型、源顶点和目标顶点的关系约束,构建图的连接规则。

IndexLabel(索引标签)REST 接口:为顶点和边的属性创建索引,加速基于属性的查询和过滤操作。

Vertex(顶点)REST 接口:创建、查询、更新和删除图中的顶点数据,支持批量操作和条件过滤。

Edge(边)REST 接口:创建、查询、更新和删除顶点之间的关系数据,支持批量操作和方向查询。

Variable(变量)REST 接口:存储和管理键值对形式的全局变量,支持图级别的配置和状态管理。

Gremlin(图查询语言)REST 接口:通过 HTTP 接口执行 Gremlin 图遍历查询语言脚本。

Cypher(图查询语言)REST 接口:通过 HTTP 接口执行 OpenCypher 声明式图查询语言。

Traverser(图遍历)REST 接口:执行复杂的图算法和路径查询,包括最短路径、K近邻、相似度计算等高级分析功能。

Task(任务管理)REST 接口:查询和管理异步任务的执行状态,如索引重建、图遍历等长时任务。

Rebuild(重建索引)REST 接口:重建图模式的索引,确保索引数据与图数据保持一致性。

Rank(图排序)REST 接口:执行图节点排序算法,如 PageRank、个性化 PageRank 等中心性分析。

Metrics(监控指标)REST 接口:获取系统运行时的性能指标、统计信息和健康状态数据。

Other(其他接口)REST 接口:提供版本查询、API 列表、异常堆栈开关、IP 白名单和 Arthas 诊断代理等辅助功能。