业务面API概览
GES业务面API包括点操作、边操作、元数据操作、Gremlin操作、算法、路径、图统计、子图操作和Job管理。
名称 |
版本 |
URL |
功能描述 |
---|---|---|---|
点过滤查询 |
POST/ges/v1.0/{projectId}/graphs/{graphName}/vertices/action?action_id=query |
根据某个过滤条件查询点,比如点元数据中含有age属性,过滤条件可以为age>18。 |
|
查询点详情 |
GET/ges/v1.0/{projectId}/graphs/{graphName}/vertices/detail?vertexIds={vertexIds} |
给定一个点或者一组点的集合,查询这些点的详情,包括Label信息。 |
|
添加点 |
POST /ges/v1.0/{projectId}/graphs/{graphName}/vertices |
添加一个点。 |
|
删除点 |
DELETE/ges/v1.0/{projectId}/graphs/{graphName}/vertices/{vertexId} |
删除一个点。 |
|
更新点属性 |
POST/ges/v1.0/{projectId}/graphs/{graphName}/vertices/{vertexId}/properties/action?action_id={actionId} |
对点属性进行修改,包括新增、修改和删除。 |
|
批量点查询 |
POST/ges/v1.0/{projectId}/graphs/{graphName}/vertices/action?action_id=batch-query |
批量查询点的详情。 |
|
批量添加点 |
POST /ges/v1.0/{projectId}/graphs/{graphName}/vertices/action?action_id=batch-add |
批量添加点的操作。 |
|
批量删除点 |
POST /ges/v1.0/{projectId}/graphs/{graphName}/vertices/action?action_id=batch-delete |
根据批量节点ID删除节点。 |
|
批量更新点属性 |
POST /ges/v1.0/{projectId}/graphs/{graphName}/vertices/properties/action?action_id={actionId} |
批量更新点的属性。 |
|
添加点label |
POST /ges/v1.0/{projectId}/graphs/{graphName}/vertices/{vertexId}/labels |
添加点的标签。 |
|
删除点label |
DELETE /ges/v1.0/{projectId}/graphs/{graphName}/vertices/{vertexId}/labels/{labelName} |
删除点的标签。 |
|
导出过滤后的点 |
POST /ges/v1.0/{projectId}/graphs/{graphName}/vertices/action?action_id=export |
导出满足过滤条件的顶点集合。 |
|
删除过滤后的点 |
POST /ges/v1.0/{projectId}/graphs/{graphName}/vertices/action?action_id=delete |
删除满足过滤条件的顶点集合。 |
名称 |
版本 |
URL |
功能描述 |
---|---|---|---|
边过滤查询 |
POST/ges/v1.0/{projectId}/graphs/{graphName}/edges/action?action_id=query |
根据边的属性上的过滤条件进行过滤,查询符合过滤条件的边。 |
|
查询边详情 |
GET /ges/v1.0/{projectId}/graphs/{graphName}/edges/detail?source={sourceVertex}&target={targetVertex}&index={index} |
根据边的源点和目的点查询边的详情,包括边的Label信息。 |
|
添加边 |
POST /ges/v1.0/{projectId}/graphs/{graphName}/edges |
添加一条边。 |
|
删除边 |
DELETE /ges/v1.0/{projectId}/graphs/{graphName}/edges?source={sourceVertex}&target={targetVertex}&index={index} |
删除一条边。 |
|
更新边属性 |
POST/ges/v1.0/{projectId}/graphs/{graphName}/edges/properties/action?action_id={actionId}&source={sourceVertex}&target={targetVertex}&index={index} |
对边属性进行修改,包括新增、修改和删除。 |
|
批量边查询 |
POST/ges/v1.0/{projectId}/graphs/{graphName}/edges/action?action_id=batch-query |
批量查询边的详情。 |
|
批量添加边 |
POST /ges/v1.0/{projectId}/graphs/{graphName}/edges/action?action_id=batch-add |
批量添加边的操作。 |
|
批量删除边 |
POST /ges/v1.0/{projectId}/graphs/{graphName}/edges/action?action_id=batch-delete |
根据批量边的起点、终点以及索引,删除这些边。 |
|
批量更新边属性 |
POST /ges/v1.0/{projectId}/graphs/{graphName}/edges/properties/action?action_id={actionId} |
批量更新边属性。 |
|
导出过滤后的边 |
POST /ges/v1.0/{projectId}/graphs/{graphName}/edges/action?action_id=export |
导出满足过滤条件的边集合。 |
|
删除过滤后的边 |
POST /ges/v1.0/{projectId}/graphs/{graphName}/edges/action?action_id=delete |
删除满足过滤条件的边集合。 |
名称 |
版本 |
URL |
功能描述 |
---|---|---|---|
添加label |
POST /ges/v1.0/{projectId}/graphs/{graphName}/schema/labels |
添加label。 |
|
添加点label |
POST /ges/v1.0/{projectId}/graphs/{graphName}/vertices/{vertexId}/labels |
添加点label。 |
|
查询元数据详情 |
GET /ges/v1.0/{projectId}/graphs/{graphName}/schema |
查询元数据详情。 |
名称 |
版本 |
URL |
功能描述 |
---|---|---|---|
新建索引 |
POST /ges/v1.0/{projectId}/graphs/{graphName}/indices |
新建索引。 |
|
删除索引 |
DELETE /ges/v1.0/{projectId}/graphs/{graphName}/indices/{indexName} |
删除索引。 |
|
查询索引 |
GET /ges/v1.0/{projectId}/graphs/{graphName}/indices |
查询索引。 |
名称 |
版本 |
URL |
功能描述 |
---|---|---|---|
执行Gremlin查询 |
POST /ges/v1.0/{projectId}/graphs/{graphName}/action?action_id=execute-gremlin-query |
执行Gremlin查询。 |
名称 |
版本 |
URL |
功能描述 |
---|---|---|---|
执行算法 |
POST /ges/v1.0/{projectId}/graphs/{graphName}/action?action_id=execute-algorithm |
执行算法。 |
名称 |
版本 |
URL |
功能描述 |
---|---|---|---|
查询路径详情 |
POST /ges/v1.0/{projectId}/graphs/{graphName}/paths/action?action_id=query-detail |
查询路径详情。 |
名称 |
版本 |
URL |
功能描述 |
---|---|---|---|
查询图概要信息 |
GET /ges/v1.0/{projectId}/graphs/{graphName}/summary |
查询图概要信息。 |
|
查询图版本 |
GET /ges/v1.0/{projectId}/graphs/{graphName}/version |
查询图版本。 |
名称 |
版本 |
URL |
功能描述 |
---|---|---|---|
子图查询 |
POST/ges/v1.0/{projectId}/graphs/{graphName}/subgraphs/action?action_id=query |
查询输入的节点和它们之间所有边所构成的子图。 |
名称 |
版本 |
URL |
功能描述 |
---|---|---|---|
查询Job状态 |
GET/ges/v1.0/{projectId}/graphs/{graphName}/jobs/{jobId}/status?offset=offset&limit=limit |
查询Job状态。 |
|
取消Job |
DELETE https://Endpoint/ges/v1.0/{projectId}/graphs/{graphName}/jobs/{jobId} |
取消Job。 |
|
导出job返回结果到文件 |
POST /ges/v1.0/{projectId}/graphs/{graphName}/jobs/{jobId}/action?action_id=export-result |
用于将异步任务(jobId)的执行结果(result)导出到文件。 |
|
查询job列表 |
GET /ges/v1.0/{projectId}/graphs/{graphName}/jobs/status?limit={limit}&offset={offset} |
异步任务jobId返回后,若jobId业务层丢失无法通过接口重新获取,现在提供一个新的接口用于查询engine中保存的所有异步任务,返回每个任务的jobId、job状态、原始请求。 |
