Querying K Hop Vertices or Edges Using a Filter

Function

This API filters the k-hop process layer by layer, and lists the k hop vertices or edges that meet the filtering criteria.

URI

• URI format

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

• Parameter description

  Table 1 URI parameter description

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID, which is used for resource isolation. For details, see Obtaining a Project ID.
  graph_name	Yes	String	Graph name

Request

• Request example
  • Synchronization

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

  • Asynchronization

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

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

Response

• Synchronous response
  • Parameter description

    Table 10 Parameter description

    Parameter	Mandatory	Type	Description
    errorMessage	No	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.
    errorCode	No	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
    data	No	Json	Query results. This parameter is left blank when the query fails.

    Table 11 data parameter description

    Parameter	Mandatory	Type	Description
    vertices	No	List	Vertex result set. If the last layer of filters is vertex filtering, the data contains vertices.
    edges	No	List	Edge result set. If the last layer of filters is edge filtering, the data contains edges.
    paths	No	List	Path set. This parameter is available only when with_path is set to true. For details about the formats, see Table 12.

    Table 12 path parameter description

    Parameter	Mandatory	Type	Description
    source	Yes	String	Source vertex ID
    target	Yes	String	Target vertex ID
    index	Yes	String	Edge index
    label	Yes	String	Edge label

  • Response example (successful request)

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

  • Response example (failed request)

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

Return Value

• Normal

  200

• Abnormal

  Table 14 Return code for failed requests

  Return Value	Description
  400 Bad Request	Request error.
  401 Unauthorized	Authentication failed.
  403 Forbidden	No operation permission.
  404 Not Found	The requested resource was not found.
  500 Internal Server Error	Internal service error.
  503 Service Unavailable	Service unavailable.