更新时间:2024-07-26 GMT+08:00

批量点查(1.1.9)

功能介绍

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

URI

POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-query
表1 路径参数

参数

是否必选

类型

说明

project_id

String

项目ID。获取方法请参见获取项目ID

graph_name

String

图名称。

请求参数

表2 Body参数说明

参数

是否必选

类型

说明

vertices

String

待查询的点ID数组。

响应参数

表3 响应Body参数

参数

类型

说明

errorMessage

String

系统提示信息。

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

errorCode

String

系统提示信息。

  • 执行成功时,字段可能为空。
  • 执行失败时,用于显示错误码。

data

Object

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

result

String

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

请求示例

根据批量节点ID查询节点信息,待查询的点ID数组为"27003509_北京中央电视台大楼"和"39636392_八达岭长城"。

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

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

响应示例

状态码: 200

成功响应示例

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

状态码: 400

失败响应示例

Http Status Code: 400
{
  "errorMessage": " Bad Request, parameter vertices cannot be null",
  "errorCode": "GES.8214"
}

状态码

返回值

说明

400 Bad Request

请求错误。

401 Unauthorized

鉴权失败。

403 Forbidden

没有操作权限。

404 Not Found

找不到资源。

500 Internal Server Error

服务内部错误。

503 Service Unavailable

服务不可用。

错误码

请参见错误码