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

批量点查

功能介绍

根据批量节点ID查询节点信息,返回这些节点的详情,包括标签和属性等。

URI

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

    参数

    是否必选

    类型

    说明

    project_id

    String

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

    graph_name

    String

    图名称。

请求

  • 请求样例
    POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-query  
    {
      "vertices":
      ["27003509_电视台大楼",
      "39636392_八达岭长城"]
    } 

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

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

    参数

    是否必选

    类型

    说明

    vertices

    String

    待查询的顶点ID数组。

响应

  • 要素说明
    表3 要素说明

    参数

    是否必选

    类型

    说明

    errorMessage

    String

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

    errorCode

    String

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

    data

    Json

    查询成功时包含data字段,data字段中包含vertices查询结果。

    result

    String

    查询成功时值为success,失败时值为failed。

  • 请求成功样例
    Http Status Code: 200
    {
        "data": {
            "vertices": [
                {
                    "id": "27003509_电视台大楼",
                    "label": "tag",
                    "properties": {
                        "popularity": [
                            0
                        ],
                        "name": [
                            "电视台大楼"
                        ],
                        "alias": [
                            "光华路办公区",
                            "总部大楼",
                            "大裤衩",
                            "总部大楼"
                        ]
                    }
                },
                {
                    "id": "39636392_八达岭长城",
                    "label": "tag",
                    "properties": {
                        "popularity": [
                            0
                        ],
                        "name": [
                            "八达岭长城"
                        ],
                        "alias": [
                            "长城"
                        ]
                    }
                }
            ]
        }
         "result": "success" 
     }
  • 请求失败样例
    Http Status Code: 400
    {
      "errorMessage": " Bad Request, parameter vertices cannot be null",
      "errorCode": "GES.8214"
    }