Filtered-query API(2.2.13)

功能介绍

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

URI

请求参数

当executionMode为同步时，返回的点个数不能超过10万。

• 支持左值是集合：body体中左值为string。
• 支持右值是集合：选择否，说明即使支持也仅匹配集合中第一个字符串。
• boolean值匹配，当右值输入为”true”时，将被识别为“true”进行匹配，否则识别为“false”进行匹配。

响应参数

• 同步返回

  表10 响应Body参数说明

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

  表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。

• 异步返回

  表13 响应Body参数说明

  参数	类型	说明
  errorMessage	String	系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。
  errorCode	String	系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。
  jobId	String	执行算法任务ID。请求失败时，该字段为空。
  jobType	Integer	任务类型。请求失败时，该字段为空。

请求示例

• （同步模式）列出满足过滤条件的第k跳节点或边，执行模式是同步，不进行可视化即查询job结果分页返回。

  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"
      ]
  }

• （异步模式）列出满足过滤条件的第k跳节点或边，执行模式是异步，不进行可视化即查询job结果分页返回。

  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，列出满足过滤条件的第k跳节点或边，执行模式是同步，不进行可视化即查询job结果分页返回。

  {
      "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"
    ]
  }

响应示例

• 同步返回

  状态码： 200

  成功响应示例

  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"
              }
          ]
      }
  }
  

  状态码： 400

  失败响应示例

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

状态码

错误码

请参见错误码。