Filtered-query API

功能介绍

对k跳过程进行逐层过滤，列出满足过滤条件的第k跳节点或边。

URI

• URI 格式

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

• 参数说明

  表1 URI参数说明

  参数	是否必选	类型	说明
  project_id	是	String	项目编号，用于资源隔离。请参考获取项目ID。
  graph_name	是	String	图名称。

请求

• 请求样例
  • 同步

    POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=filtered-query
    {
        "executionMode": "sync",
        "visulized": "false",
        "filters": [
            {
                "operator": "outV"
            },
            {
                "operator": "out",
                "edge_filter": {
                    "property_filter": {
                        "leftvalue": {
                            "label_name": "labelName"
                        },
                        "predicate": "=",
                        "rightvalue": {
                            "value": "rate"
                        }
                    }
                }
            }
        ],
        "full_path": false,
        "vertices": [
            "tr_10"
        ]
    }

  • 异步

    POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=filtered-query
    {
        "executionMode": "async",
        "visulized": "false",
        "filters": [
            {
                "operator": "outV"
            },
            {
                "operator": "out",
                "edge_filter": {
                    "property_filter": {
                        "leftvalue": {
                            "label_name": "labelName"
                        },
                        "predicate": "=",
                        "rightvalue": {
                            "value": "rate"
                        }
                    }
                }
            }
        ],
        "full_path": false,
        "vertices": [
            "tr_10"
        ]
    }

  • 嵌套property_filter

    {
        "executionMode": "sync",
        "filters": [
            {
                "operator": "outV",
                 "vertex_filter": {
                    "property_filter": {
                        "leftvalue": {
                     "property_filter": {
                        "leftvalue": {
                            "property_name": "genres"
                         },
                      "predicate": "PREFIX",
                      "rightvalue": {
                      "value": "A|"
                }
              }
            },
                   "predicate": "&",
                   "rightvalue": {
                   "property_filter": {
                   "leftvalue": {
                   "label_name": "labelName"
                },
                   "predicate": "=",
                    "rightvalue": {
                     "value": "movie"
                  }
                }
              }
           }
         } 
        }
      ],
            "vertices": [
            "tr_3"
      ]
    }

响应

• 同步返回
  • 要素说明

    表10 要素说明

    参数	是否必选	类型	说明
    errorMessage	否	String	系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。
    errorCode	否	String	系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。
    data	否	Json	查询结果。查询失败时，字段为空。

    表11 data参数说明

    参数	是否必选	类型	说明
    vertices	否	List	点的结果集合。filters最后一层为点过滤时，data中将包含vertices。
    edges	否	List	边的结果集合。filters最后一层为边过滤时，data中将包含edges。
    paths	否	List	路径信息集合。with_path为true时可输出。格式见表12。

    表12 path参数说明

    参数	是否必选	类型	说明
    source	是	String	源点ID
    target	是	String	终点ID
    index	是	String	边index
    label	是	String	边label

  • 请求成功样例

    Http Status Code: 200
    {
        "data": {
            "edges": [
                {
                    "index": "1",
                    "source": "tr_1",
                    "label": "rate",
                    "properties": {
                        "Rating": [
                            0
                        ],
                        "Datetime": [
                            ""
                        ]
                    },
                    "target": "tr_3"
                },
                ……,
                {
                    "index": "199998",
                    "source": "tr_1",
                    "label": "rate",
                    "properties": {
                        "Rating": [
                            0
                        ],
                        "Datetime": [
                            ""
                        ]
                    },
                    "target": "tr_200000"
                }
            ]
        }
    }
    

  • 请求失败样例

    Http Status Code: 400
    {
        "errorMessage": "graph [tesdt_117] is not found",
        "errorCode": "GES.8806"
    }

返回值

• 正常

  200

• 异常

  表14 异常返回值说明

  返回值	说明
  400 Bad Request	请求错误。
  401 Unauthorized	鉴权失败。
  403 Forbidden	没有操作权限。
  404 Not Found	找不到资源。
  500 Internal Server Error	服务内部错误。
  503 Service Unavailable	服务不可用。