文档首页> 图引擎服务 GES> API参考> 业务面API> 内存版> 路径API> 查询路径详情(1.1.6)
更新时间：2023-07-19 GMT+08:00
查看PDF

查询路径详情(1.1.6)

功能介绍

查询路径详情。将列举出所有可能的路径。

URI

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

参数

是否必选

类型

说明

project_id

是

String

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

graph_name

是

String

图名称。

请求示例

查询路径详情，需要查询的路径分别为Ray，Lethal Weapon和Alice，不设置查询方向。

post http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/paths/action?action_id=query-detail
{
    "paths":[
        [
            "Ray",
            "Lethal Weapon",
            "Alice"
        ]
    ],
    "directed":false
}

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

请求参数

表2 Body参数说明

参数

是否必选

类型

说明

paths

是

List

需要查询的路径集合。

directed

否

Boolean

查询路径为有向或无向：

true：有向

false: 无向

default=false

响应参数

表3 响应Body参数说明

参数

类型

说明

errorMessage

String

系统提示信息。

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

errorCode

String

系统提示信息。

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

data

Object

查询结果。

查询失败时，字段为空。
表4 data参数说明

参数

类型

说明

outputs

Object

包含path的查询返回结果。

paths

List

JsonArray格式，包含具有点和边详细信息的路径集合。

说明：

返回路径中：

  • 当点不存在时，对应位置为“{}”；
  • 当两点之间不存在边时，对应位置为"{"edges"：[]}"

响应示例

状态码： 200

成功响应示例 
Http Status Code: 200
{
    "data": {
        "outputs":{
                "paths":[
                    [
                        {
                            "id":"Ray",
                            "label":"user",
                            "properties":{
                                "Name":["雷"],
                                "Gender":["M"],
                                "Age":["18-24"],
                                "Occupation":["college/grad student"],
                                "Zip-code":["90241"]
                            }
                        },
                        {
                            "edges":[
                                {
                                    "source":"Ray",
                                    "target":"Lethal Weapon",
                                    "index":"1",
                                    "label":"rate",
                                    "properties":{
                                        "Score":[2],
                                        "Datetime":["2000-11-22 19:16:16"]
                                    }
                                }
                            ]
                        },
                        {
                            "id":"Alice",
                            "label":"user",
                            "properties":{
                                "Name":["爱丽丝"],
                                "Gender":["F"],
                                "Age":["25-34"],
                                "Occupation":["academic/educator"],
                                "Zip-code":["79928"]
                            }
                        }
                    ]
                ]
          }
    }
}

状态码： 400

失败响应示例

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

状态码

返回值

说明

400 Bad Request

请求错误。

401 Unauthorized

鉴权失败。

403 Forbidden

没有操作权限。

404 Not Found

找不到资源。

500 Internal Server Error

服务内部错误。

503 Service Unavailable

服务不可用。

错误码

请参见错误码。

父主题： 路径API