更新时间:2022-04-12 GMT+08:00
分享

执行子图算法

概述

根据输入调整子图生成方式,在生成的子图上,执行特定算法。

URL

POST /ges/v1.0/{project_id}/graphs/{graph_name}/subgraphs/action?action_id=execute-algorithm

参数说明

参数

是否必选

类型

说明

project_id

String

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

graph_name

String

图名称。

请求

  • 请求样例
    POST  http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/subgraphs/action?action_id=execute-algorithm
     { 
      "algorithmName":"connected_component",
    "subgraphCreator": {
            "name": "filtered",
            "parameters": {
                "edge_filter": {
                    "property_filter": {
                        "leftvalue": {
                            "label_name": "labelName"
                        },
                        "predicate": "=",
                        "rightvalue": {
                            "value": "PHYSICAL_LINK"
                        }
                    }
                }
            }
       },
     "parameters":{ 
             "num_thread":4 
      } 
     }
  • 参数说明
    表1 Body参数说明

    参数

    是否必选

    类型

    说明

    algorithmName

    String

    算法名字。

    取值范围:

    • connected_component。
    • kcore。

    parameters

    JSON

    算法参数描述。

    subgraphCreator

    Json

    子图参数。详情请参考subgraphCreator参数说明

    表2 subgraphCreator参数说明

    参数

    是否必选

    类型

    说明

    name

    String

    子图生成器类型。当前支持的取值为filtered。

    parameters

    JSON

    子图生成器的名字不同,parameters格式不同。

    表3 name=filtered时,parameters参数说明

    参数

    是否必选

    类型

    说明

    vertex_filter

    String

    点过滤条件。

    edge_filter

    String

    边过滤条件。

响应

表4 要素说明

参数

是否必选

类型

说明

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

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

    返回值

    说明

    400 Bad Request

    请求错误。

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。

分享:

    相关文档

    相关产品

close