更新时间:2025-03-05 GMT+08:00

持久化版

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

表1 点操作API

名称

URL

功能描述

查询点详情

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

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

批量点查询

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

批量查询点的详情。

批量添加点

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

批量添加点的操作。

批量删除点

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

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

批量更新点属性

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

批量更新点的属性。

表2 边操作API

名称

URL

功能描述

查询边详情

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

根据边的源点和目的点查询边的详情,包括边的Label信息。

批量边查询

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

批量查询边的详情。

批量添加边

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

批量添加边的操作。

批量删除边

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

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

批量更新边属性

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

批量更新边属性。

表3 元数据操作API

名称

URL

功能描述

添加label

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

添加label。

更新label

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

更新label。

查询图元数据详情

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

查询元数据详情。

查询label

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

查询label。

生成数据资产

POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema/data-assets

生成数据资产。

获取数据资产

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

获取数据资产。

表4 索引操作API

名称

URL

功能描述

新建索引

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

新建索引。

删除索引

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

删除索引。

查询索引

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

查询索引。

批量新建索引

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

支持一次性新建多个索引,相较于逐个建立索引,批量新建多个索引会减少数据扫描的次数,可降低整体耗时。

表5 HyG图管理API

名称

URL

功能描述

创建HyG图

POST /ges/v1.0/{project_id}/hyg/{graph_name}

创建一个HyG图。

HyG图数据同步

POST /ges/v1.0/{project_id}/hyg/{graph_name}/sync

将图数据库的更新信息同步到HyG计算引擎。

查询HyG图概要信息

GET /ges/v1.0/{project_id}/hyg/{graph_name}/summary

查询HyG图的点数量、边数量、属性信息、切分策略等概要信息。

删除HyG图

DELETE /ges/v1.0/{project_id}/hyg/{graph_name}

删除HyG图。

查询HyG图列表

GET /ges/v1.0/{project_id}/hyg

查询HyG图列表。

HyG导入图

POST /ges/v1.0/{project_id}/hyg/{graph_name}/import-graph

导入HyG图数据。

表6 HyG算法API

名称

URL

功能描述

执行算法

POST /ges/v1.0/{project_id}/graphs/{graph_name}/hyg/algorithm

执行HyG算法。

执行DSL算法

POST /ges/v1.0/{project_id}/hyg/{graph_name}/dsl

提供灵活的DSL帮助用户低成本设计并运行算法。

表7 HyG Job管理API

名称

URL

功能描述

HyG算法结果转存

POST /ges/v1.0/{project_id}/hyg/{graph_name}/jobs/{job_id}/export-result

用于将算法(jobId)的执行结果转存到OBS,供用户查看全量结果。

取消HyG Job

DELETE /ges/v1.0/{project_id}/hyg/{graph_name}/jobs/{job_id}

用于取消已经提交的HyG作业。(当前只支持取消排队中的任务)。

表8 原生算法API

名称

URL

功能描述

执行算法

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

执行原生算法。

表9 图统计API

名称

URL

功能描述

查询图概要信息

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

查询图概要信息。

查询图版本

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

查询图版本。

表10 图操作API

名称

URL

功能描述

导入图

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

导入图数据 。

清空图

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

清空图数据。

导出图

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

导出图数据。

创建图

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

进行创建图操作。

删除图

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

进行删除图操作。

图列表

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

输出图列表信息。

表11 Job管理API

名称

URL

功能描述

查询Job状态

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

查询Job状态。

查询job列表

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

异步任务jobId返回后,若jobId业务层丢失无法通过接口重新获取,现在提供一个新的接口用于查询engine中保存的所有异步任务,返回每个任务的jobId、job状态、原始请求。

表12 Cypher操作API

名称

URL

功能描述

Cypher操作API

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

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