文档首页/ 图引擎服务 GES/ API参考/ 业务面API/ 内存版/ 子图操作API/ 执行子图算法
更新时间：2023-07-19 GMT+08:00
查看PDF
分享

执行子图算法

概述

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

URL

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

参数说明

参数

是否必选

类型

说明

project_id

是

String

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

graph_name

是

String

图名称。

请求参数

表1 Body参数说明

参数

是否必选

类型

说明

algorithmName

是

String

算法名字。

取值范围：

  • connected_component。
  • kcore。

parameters

是

JSON

算法参数描述。

subgraphCreator

是

Object

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

参数

是否必选

类型

说明

name

否

String

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

parameters

是

JSON

子图生成器的名字不同，parameters格式不同。
表3 name=filtered时，parameters参数说明

参数

是否必选

类型

说明

vertex_filter

否

String

点过滤条件。

edge_filter

否

String

边过滤条件。

响应参数

表4 响应Body参数说明

参数

类型

说明

errorMessage

String

系统提示信息。

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

errorCode

String

系统提示信息。

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

jobId

String

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

说明：

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

jobType

Integer

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

请求示例

在生成的子图上执行特定算法，算法名称为connected_component，子图生成器类型为filtered。

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 
  } 
 }

响应示例

状态码： 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

服务不可用。

错误码

请参见错误码。

父主题： 子图操作API

相关文档