更新时间:2024-05-23 GMT+08:00

OD中介中心度(od_betweenness)

功能介绍

根据输入参数,执行OD中介中心度算法。

OD中介中心度算法(od_betweenness)在已知一系列OD出行计划前提下,以经过某个点/某条边的最短路径数目来刻画边重要性的指标。

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

参数

是否必选

类型

说明

directed

Boolean

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

weight

String

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

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

OD_pairs

String

起点终点节点对,

标准csv格式,起点和终点以英文逗号分隔,各起点和终点节点对之间以换行符“\\n"分隔,例如:“Alice,Nana\\nLily,Amy"。

seeds

String

热点事件发生地的节点ID,ID个数在30以内。

当未知OD_pairs数据时,输入seeds数据。标准csv格式,节点之间以英文逗号分隔,例如:“Alice,Nana"。

modes

String

与seeds对应的热点事件类别。

  • IN: 表示以热点事件发生地点的节点ID作为起点 。
  • OUT:表示以热点事件发生地点的节点ID作为终点。

attendees

String

与seeds对应的热点事件参加人数,取值范围为[1,1000000]。

标准csv格式,数字之间以英文逗号分隔,例如:“10,20"。

OD_pairs和seeds参数二选一,当OD_pairs和seeds同时输入时,以OD_pair为准,忽略seeds。

响应参数

参数

类型

说明

errorMessage

String

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

errorCode

String

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

jobId

String

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

说明:

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

jobType

Integer

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

请求示例

POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm  
 { 
  "algorithmName":"edge_betweenness", 
  "parameters":{ 
         "OD_pairs":"1,2\\n3,4", 
         "directed":true
  } 
 }

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

服务不可用

错误码

请参见错误码