查询树详情
功能介绍
输入一个点,输出以该点为起点的一棵树, 包括树中的节点和边,以及可达路径信息。参数可以为方向(出、入、出和入)、最大跳数和需要过滤的边属性等。
URI
| 参数 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| project_id | 是 | String | 项目ID。获取方法请参见获取项目ID。 |
| graph_name | 是 | String | 图名称。 |
请求示例
Post /ges/v1.0/{project_id}/graphs/test/action?action_id=query-tree
{
"executionMode": "sync",
"rootId": "0",
"maxDepth": 20,
"maxVertices": 5000,
"maxEdges": 10000,
"maxDegree": 1000,
"direction": "both",
"labelFilters": [
"edge",
"default"
],
"withVertex": true,
"withEdge": true
} 请求参数
| 参数 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| executionMode | 否 | String |
默认为“async”,异步返回。 |
| rootId | 是 | String | 根节点ID。 |
| maxDepth | 是 | Integer | 树深度,也是路径的最大长度,取值范围[1,20]。 |
| direction | 是 | String | 可选值。 in:查询入边; out:查询出边; both:查询出边和入边。 |
| labelFilters | 否 | Array of Json | 按label过滤路径,默认为“[]”。 |
| maxVertices | 是 | Integer | 最多可获得的点数,取值范围(0,200000]。 |
| maxEdges | 是 | Integer | 最多可获得的边数,取值范围(0,200000]。 |
| maxDegree | 否 | Long | 用于超级节点的访问,当访问到的节点单向所连边数大于maxDegree时,将不再访问该节点的下一跳。 |
| withVertex | 否 | Boolean | 是否输出点数据,默认为“true”。 |
| withEdge | 否 | Boolean | 是否输出边数据,默认为“true”。 |
异步状态下同时输出点和边数据,不支持分页。
响应参数
| 参数 | 类型 | 说明 |
|---|---|---|
| errorMessage | String | 系统提示信息。
|
| errorCode | String | 系统提示信息。
|
| data | Object | 查询失败时,字段为空。 |
响应示例
- 同步
成功响应示例
Http Status Code: 200 { "data": { "edges" : [ { "index" : "0", "label" : "edge", "properties" : { "_type" : [ "ACTED_IN" ], "role" : [ "Neo" ] }, "source" : "546", "target" : "0" }, ... ], "vertices" : [ { "id" : "546", "label" : "node", "properties" : { "_labels" : [ "Actor" ], "d" : [ "" ], "name" : [ "Keanu Reeves" ], "personId" : [ "keanu" ], "title" : [ "" ], "year" : [ "" ] } }, … ] } }状态码: 400
失败响应示例Http Status Code: 400 { "errorMessage": "graph [test] is not found", "errorCode": "GES.8808" }
状态码
| 返回值 | 说明 |
|---|---|
| 400 Bad Request | 请求错误。 |
| 401 Unauthorized | 鉴权失败。 |
| 403 Forbidden | 没有操作权限。 |
| 404 Not Found | 找不到资源。 |
| 500 Internal Server Error | 服务内部错误。 |
| 503 Service Unavailable | 服务不可用。 |
错误码
请参见错误码。