文档首页/ 图引擎服务 GES/ API参考/ 业务面API/ 持久化版/ HyG算法API/ 算法API参数参考/ 单点环路检测(single_vertex_circles_detection)
更新时间:2024-05-23 GMT+08:00

单点环路检测(single_vertex_circles_detection)

功能介绍

根据输入参数,执行单点环路检测算法。

单点环路检测(single_vertex_circles_detection)意在寻找图中的环路,环路上的点较好地体现了该点的重要性。

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。

min_circle_length

Integer

最小圈长,取值范围[3, 15],默认值为3。

max_circle_length

Integer

最大圈长(要求min_circle_length<= max_circle_length),取值范围[3, 15],默认值为10。

limit_circle_number

Integer

限定寻找圈的个数,取值范围[1, 100000],默认值为100。

响应参数

参数

类型

说明

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":"single_vertex_circles_detection", 
  "parameters":{ 
         "source":66, 
         "min_circle_length":3, 
        "max_circle_length":7, 
        "limit_circle_number":10000
  } 
 }

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

服务不可用

错误码

请参见错误码