更新时间:2023-09-22 GMT+08:00

执行DSL算法

功能介绍

提供灵活,可控的DSL帮助用户低成本设计并运行算法。DSL算法详细介绍请参考DSL语法介绍

URI

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

    参数

    是否必选

    参数类型

    描述

    project_id

    String

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

    graph_name

    String

    图名称。

请求参数

表2 Body参数

参数

是否必选

参数类型

描述

commands

String

该自定义操作集执行的具体指令。语法详情见语法介绍一章。

响应参数

表3 响应要素说明

参数

类型

说明

errorMessage

String

系统提示信息。

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

errorCode

String

系统提示信息。

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

data

Object

查询结果。查询失败时,字段为空。

请求示例

POST/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=algorithm-query
 {
     "commands":"Match<Vertex> v(['1']); v.repeat(bothV()).limit(2); return v;"
 }

响应示例

  • 请求成功样例

    状态码:200

    OK
    {
         "data":{
             "vertices":[
                 {
                     "id":"1",
                     "label":"movie",
                     "properties":{
                         "genres":[
                             "Comedy"
                         ],
                         "movieid":[
                             1
                         ],
                         "title":[
                             "Airplane! (1980)"
                         ]
                     }
                 }
             ],
             "runtime":0.126476598
         }
     }
  • 请求失败样例
    {  
         "errorCode":"GES.8814",
         "errorMessage":"Unsupported API."
     }

返回值

  • 正常

    200

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

    返回值

    说明

    400 Bad Request

    请求错误。

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。