图引擎服务 GES图引擎服务 GES

文档首页> 图引擎服务 GES> API参考> API概览> 业务面API概览

更新时间：2021/09/23 GMT+08:00

编辑

查看PDF

业务面API概览

GES业务面API包括点操作、边操作、元数据操作、Gremlin操作、算法、路径、图统计、子图操作和Job管理。

表1 点操作API
名称	版本	URL	功能描述
点过滤查询	1.0.0	POST/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=query	根据某个过滤条件查询点，比如点元数据中含有age属性，过滤条件可以为age>18。
查询点详情	1.0.0	GET/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/detail?vertexIds={vertex_ids}	给定一个点或者一组点的集合，查询这些点的详情，包括Label信息。
添加点	1.0.6	POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices	添加一个点。
删除点	1.0.6	DELETE/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}	删除一个点。
更新点属性	1.1.6	POST/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}/properties/action?action_id={actionId}	对点属性进行修改，包括新增、修改和删除。
批量点查询	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}	批量更新点的属性。
添加点label	1.1.6	POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}/labels	添加点的标签。
删除点label	1.1.6	DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}/labels/{label_name}	删除点的标签。
导出过滤后的点	2.2.7	POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=export	导出满足过滤条件的顶点集合。
删除过滤后的点	2.2.7	POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=delete	删除满足过滤条件的顶点集合。

表2 边操作API
名称	版本	URL	功能描述
边过滤查询	1.0.0	POST/ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=query	根据边的属性上的过滤条件进行过滤，查询符合过滤条件的边。
查询边详情	1.0.0	GET /ges/v1.0/{project_id}/graphs/{graph_name}/edges/detail?source={sourceVertex}&target={targetVertex}&index={index}	根据边的源点和目的点查询边的详情，包括边的Label信息。
添加边	1.0.6	POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges	添加一条边。
删除边	1.0.6	DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/edges?source={sourceVertex}&target={targetVertex}&index={index}	删除一条边。
更新边属性	1.1.6	POST/ges/v1.0/{project_id}/graphs/{graph_name}/edges/properties/action?action_id={actionId}&source={sourceVertex}&target={targetVertex}&index={index}	对边属性进行修改，包括新增、修改和删除。
批量边查询	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}	批量更新边属性。
导出过滤后的边	2.2.7	POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=export	导出满足过滤条件的边集合。
删除过滤后的边	2.2.7	POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=delete	删除满足过滤条件的边集合。

表3 元数据操作API
名称	版本	URL	功能描述
添加label	1.1.6	POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels	添加label。
添加点label	1.1.6	POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}/labels	添加点label。
查询元数据详情	1.0.0	GET /ges/v1.0/{project_id}/graphs/{graph_name}/schema	查询元数据详情。

表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 Gremlin操作API
名称	版本	URL	功能描述
执行Gremlin查询	1.0.0	POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-gremlin-query	执行Gremlin查询。

表6 算法API
名称	版本	URL	功能描述
执行算法	1.0.0	POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-algorithm	执行算法。

表7 路径API
名称	版本	URL	功能描述
查询路径详情	1.1.6	POST /ges/v1.0/{project_id}/graphs/{graph_name}/paths/action?action_id=query-detail	查询路径详情。

表8 图统计API
名称	版本	URL	功能描述
查询图概要信息	1.0.0	GET /ges/v1.0/{project_id}/graphs/{graph_name}/summary	查询图概要信息。
查询图版本	2.0.0	GET /ges/v1.0/{project_id}/graphs/{graph_name}/version	查询图版本。

表9 子图操作API
名称	版本	URL	功能描述
子图查询	2.1.13	POST/ges/v1.0/{project_id}/graphs/{graph_name}/subgraphs/action?action_id=query	查询输入的节点和它们之间所有边所构成的子图。

**表10** Job管理相关接口
名称	版本	URL	功能描述
查询Job状态	1.0.0	GET/ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}/status?offset=offset&limit=limit	查询Job状态。
取消Job	1.0.0	DELETE https://Endpoint/ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}	取消Job。
导出job返回结果到文件	2.2.1	POST /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}/action?action_id=export-result	用于将异步任务（job_id）的执行结果（result）导出到文件。
查询job列表	2.2.13	GET /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/status?limit={limit}&offset={offset}	异步任务jobId返回后，若jobId业务层丢失无法通过接口重新获取，现在提供一个新的接口用于查询engine中保存的所有异步任务，返回每个任务的jobId、job状态、原始请求。

**表11** 其他业务面API
名称	版本	URL	功能描述
Filtered-query API	2.2.15	POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=filtered-query	对k跳过程进行逐层过滤，列出满足过滤条件的第k跳节点或边。
通过导入文件更新点边的指定属性	2.2.13	POST /v1.0/{project_id}/graphs/{graph_name}/action?action_id=import-properties	通过导入文件更新点边的指定属性。

父主题： API概览

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？

很差较差一般较好非常好

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问