文档首页> 图引擎服务 GES> API参考> 业务面API> 持久化版> HyG算法API> 算法API参数参考> 最短路径（shortest_path）
更新时间：2024-05-23 GMT+08:00
查看PDF

最短路径（shortest_path）

功能介绍

根据输入参数，执行最短路径算法。

最短路径算法（Shortest Path）用以解决图论研究中的一个经典算法问题，旨在寻找图中两节点之间的最短路径。

URI

POST /ges/v1.0/{project_id}/hyg/{graph_name}/algorithm
表1 路径参数

参数

是否必选

类型

说明

project_id

是

String

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

graph_name

是

String

图名称。

请求参数

表2 请求Body参数

参数

是否必选

类型

说明

algorithmName

是

String

算法名字。

parameters

是

parameters Object

算法参数。
表3 parameters

参数

是否必选

类型

说明

source

是

String

输入路径的起点ID。

target

是

String

输入路径的终点ID，不等于source。

directed

否

Boolean

是否考虑边的方向。取值为true或false。

说明：
  • false当前版本在有权图上不支持。
  • 当数据集不包含inedge时，若directed=true，选择一个不依赖于Inedge的算法实现版本计算输出，性能会下降；若directed=false，会报错。

weight

否

String

边上权重。取值为：空或字符串。

  • 空：边上的权重、距离默认为1。
  • 字符串：对应的边上的属性将作为权重，当某边没有对应属性时，权重将默认为1。

响应参数

参数

类型

说明

errorMessage

String

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

errorCode

String

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

jobId

String

执行算法任务ID。请求失败时，字段为空。

说明：

可以利用返回的jobId查看任务执行状态、获取算法返回结果，详情参考查询Job状态(1.0.0)。

jobType

Integer

任务类型。请求失败时，字段为空。

请求示例

POST /ges/v1.0/{project_id}/hyg/{graph_name}/algorithm
{
 "algorithmName":"shortest_path",
 "parameters":{
        "source":"1",
        "target":"5",
        "directed":true,
        "weight":"",
 }
}

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

响应示例

状态码： 200

成功响应示例

Http Status Code: 200
{  
"jobId": "4448c9fb-0b16-4a78-8d89-2a137c53454a001679122",
"jobType": 1
}

状态码： 400

失败响应示例

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

状态码

返回值

说明

400 Bad Request

请求错误

401 Unauthorized

鉴权失败

403 Forbidden

没有操作权限

404 Not Found

找不到资源

500 Internal Server Error

服务内部错误

503 Service Unavailable

服务不可用

错误码

请参见错误码。

父主题： 算法API参数参考