更新时间:2023-07-19 GMT+08:00

执行算法(1.0.0)

功能介绍

根据输入参数,执行指定算法。

URI

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

参数

是否必选

类型

说明

project_id

String

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

graph_name

String

图名称。

请求示例

执行指定算法,算法名字为pagerank,算法的权重系数为0.85,收敛精度为0.00001,最大迭代次数为1000,考虑边的方向。

POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-algorithm
{
 "algorithmName":"pagerank",
 "parameters":{
        "alpha":0.85,
        "convergence":0.00001,
        "max_iterations":1000,
        "directed":true
 }
}

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

请求参数

Body参数说明详见算法公共参数表

响应参数

表2 响应Body参数说明

参数

类型

说明

errorMessage

String

系统提示信息。

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

errorCode

String

系统提示信息。

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

jobId

String

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

说明:

可以查询jobId查看任务执行状态、获取返回结果,详情参考Job管理API

jobType

Integer

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

响应示例

状态码: 200

成功响应示例

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

状态码:4200

失败响应示例

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

服务不可用。

错误码

请参见错误码