文档首页 > > API参考> 业务面API> 算法API>

执行算法(1.0.0)

执行算法(1.0.0)

分享
更新时间:2021/05/08 GMT+08:00

功能介绍

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

URI

  • URI 格式
    POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-algorithm
  • 参数说明
    表1 URI参数说明

    参数

    是否必选

    类型

    说明

    project_id

    String

    项目编号,用于资源隔离。请参考获取项目ID

    graph_name

    String

    图名称。

请求

  • 请求样例
    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 要素说明

参数

是否必选

类型

说明

errorMessage

String

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

errorCode

String

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

job_id

String

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

说明:

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

jobType

Integer

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

  • 请求成功样例
    Http Status Code: 200
    { 
    "jobId": "4448c9fb-0b16-4a78-8d89-2a137c53454a001679122",
    "jobType": 1
    }
  • 请求失败样例
    Http Status Code: 400
    {
    "errorMessage":"graph [demo] is not found",
    "errorCode":"GES.8402"
    }

返回值

  • 正常

    200

  • 异常
    表3 异常返回值说明

    返回值

    说明

    400 Bad Request

    请求错误。

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。

分享:

    相关文档

    相关产品