更新时间:2022-02-22 GMT+08:00

点过滤查询

功能介绍

查询满足过滤条件的顶点集合。

URI

  • URI 格式
    POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=query
  • 参数说明
    表1 URI参数说明

    参数

    是否必选

    类型

    说明

    project_id

    String

    项目编号,用于资源隔离。请参考获取项目ID

    graph_name

    String

    图名称。

请求

  • 请求样例
    POST https://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=query  
    
    {
       "offset":0,
       "limit":2,
       "labels": ["movies",
                 "user"],
       "vertexFilters":[{
          "propertyName":"Age",
          "predicate":"=", 
          "values":["18-24"]
          }
       ]
    } 

    SERVER_URL:图的访问地址,取值请参考业务面API使用限制

  • 参数说明
    表2 Body参数说明

    参数

    是否必选

    类型

    说明

    labels

    labels和vertexFilters两者必选其一

    String

    顶点类型过滤条件。

    vertexFilters

    labels和vertexFilters两者必选其一

    Json

    过滤条件,按属性过滤,JsonArray格式字符串。

    offset

    Integer

    本次请求的起始位置。

    limit

    Integer

    每页资源数量的最大值,默认为10。

    sorts

    Json

    结果排序的属性,JsonArray格式字符。

    表3 sorts参数说明

    参数

    是否必选

    类型

    说明

    key

    Key和propertyName必选其一

    String

    可选值有id、label、property,分别表示对id、label和属性排序。

    propertyName

    Key和propertyName必选其一

    String

    属性名称。

    orderValue

    String

    可选“incr”和“decr”,分别表示升序和降序,默认值“incr”。

    表4 vertexFilters参数结构

    参数

    是否必选

    类型

    说明

    propertyName

    String

    属性名称。

    predicate

    String

    逻辑关系,可选值“=”、“<”、“>”、“<=”、“>=”、“range”、“has”“hasNot”。

    values

    String

    属性的值。

    type

    String

    过滤条件逻辑关系,可选值“and”和“or”,默认为“and”。

  • vertexFilters样例1
    [
     {
       "propertyName":"Gender",
       "predicate":"=",
       "values":["F"]
     },
     {
       "propertyName":"Age",
       "predicate":"range", 
       "values":["18-24","56+"],
       "type":"or"
     }
    ]

响应

表5 要素说明

参数

是否必选

类型

说明

errorMessage

String

系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误信息。

errorCode

String

系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误码。

job_id

String

查询节点任务ID。请求失败时字段为空。

说明:

可以查询jobId查看任务执行状态、获取返回结果,详情参考查询Job状态-业务面

  • 请求成功样例
    Http Status Code: 200
    {
        "jobId": "03e774f5-29ea-4187-9508-5435f3892ead016886200",
        "jobType": 1
    }
  • 请求失败样例
    Http Status Code: 400
    {
        "errorMessage": "Bad Request, parameter labels and vertexFilters cannot all be null",
        "errorCode": "GES.8203"
    }

返回值

  • 正常

    200

  • 异常
    表6 异常返回值说明

    返回值

    说明

    400 Bad Request

    请求错误

    401 Unauthorized

    鉴权失败

    403 Forbidden

    没有操作权限

    404 Not Found

    找不到资源

    500 Internal Server Error

    服务内部错误

    503 Service Unavailable

    服务不可用