文档首页/图引擎服务 GES/API参考/API概览/业务面API概览/持久化版
更新时间：2025-06-05 GMT+08:00
查看PDF
分享

持久化版

持久化版业务面API包括点操作、边操作、元数据操作、索引操作、HyG数据集管理、HyG算法、算法、图统计、图操作、Job管理、Cypher操作API。

表1 点操作API

名称

起始版本

URL

功能描述

查询点详情

1.0.0

GET /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/detail?vertexIds={vertex_ids}

给定一个点或者一组点的集合，查询这些点的详情，包括Label信息。

批量点查询

1.1.9

POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-query

批量查询点的详情。

批量添加点

2.1.16

POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-add

批量添加点的操作。

批量删除点

2.1.9

POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-delete

根据批量节点ID删除节点。

批量更新点属性

2.1.10

POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/properties/action?action_id={actionId}

批量更新点的属性。

表2 边操作API

名称

起始版本

URL

功能描述

查询边详情

1.0.0

GET /ges/v1.0/{project_id}/graphs/{graph_name}/edges/detail?source={sourceVertex}&target={targetVertex}&label={label}&sortKey={sortKey}&sortKeyType={sortKeyType}

根据边的起点、终点以及索引，查询边的详细信息，返回边上的标签和属性等。

批量边查询

1.1.6

POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-query

批量查询边的详情。

批量添加边

2.1.16

POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-add

批量添加边的操作。

批量删除边

2.1.9

POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-delete

根据批量边的起点、终点以及索引，删除这些边。

批量更新边属性

2.1.10

POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/properties/action?action_id={actionId}

批量更新边属性。

表3 元数据操作API

名称

起始版本

URL

功能描述

添加label

1.1.6

POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels

添加label。

更新label

1.1.7

POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/{label_name}/properties

更新label。

查询图元数据详情

1.0.0

GET /ges/v1.0/{project_id}/graphs/{graph_name}/schema

查询元数据详情。

查询label

2.2.18

GET /ges/v1.0/{project_id}/graphs/{graph_name}/schema?label={labelName}

查询label。

表4 索引操作API

名称

起始版本

URL

功能描述

新建索引

1.1.6

POST /ges/v1.0/{project_id}/graphs/{graph_name}/indices

新建索引。

删除索引

1.1.6

DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/indices/{indexName}

删除索引。

查询索引

1.1.6

GET /ges/v1.0/{project_id}/graphs/{graph_name}/indices

查询索引。

表5 原生算法API

名称

起始版本

URL

功能描述

执行算法

1.0.0

POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-algorithm

执行原生算法。

表6 图统计API

名称

起始版本

URL

功能描述

查询图概要信息

1.0.0

GET /ges/v1.0/{project_id}/graphs/{graph_name}/summary?label_details={labelDetails}

查询图概要信息。

查询图版本

2.0.0

GET /ges/v1.0/{project_id}/graphs/{graph_name}/version

查询图版本。

表7 图操作API

名称

起始版本

URL

功能描述

导入图

2.1.14

POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=import-graph

导入图数据 。

清空图

2.1.2

POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=clear-graph

清空图数据。

表8 Job管理API

名称

起始版本

URL

功能描述

查询Job状态

1.0.0

GET /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}/status?offset=offset&limit=limit

查询Job状态。

查询job列表

2.2.13

GET /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/status?limit={limit}&offset={offset}

用于查询engine中保存的所有异步任务，返回每个任务的jobId、job状态、原始请求。

表9 Cypher操作API

名称

起始版本

URL

功能描述

Cypher操作API

2.2.16

POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-cypher-query

使用Cypher语句可以查询GES中的数据，并返回结果

表10 交互式事务API

名称

URL

功能描述

创建事务

POST /ges/v1.0/{project_id}/graphs/{graph_name}/transaction

创建事务。

执行事务Cypher

POST /ges/v1.0/{project_id}/graphs/{graph_name}/transaction/{commit}

执行事务Cypher。

提交事务

POST /ges/v1.0/{project_id}/graphs/{graph_name}/transaction/{commit}/commit

提交事务。

回滚事务

DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/transaction/{commit}

回滚事务。

表11 运维监控API

名称

URL

功能描述

查看监控指标

GET /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}/status?offset=offset&limit=limit

查询Job状态。

查看实时请求

GET /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/status?limit={limit}&offset={offset}

用于查询engine中保存的所有异步任务，返回每个任务的jobId、job状态、原始请求。

父主题：业务面API概览

相关文档