更新时间:2022-08-09 GMT+08:00

执行Gremlin查询

功能介绍

根据Gremlin语句,返回查询结果。

URI

  • URI 格式
    POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-gremlin-query
  • 参数说明
    表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-gremlin-query
    {       
        "command":"g.V().limit(100)" 
    }
  • Body参数说明
    表2 Body参数说明

    参数

    是否必选

    类型

    说明

    command

    String

    查询命令(Gremlin语言)。

响应

  • 要素说明
    表3 响应要素说明

    参数

    是否必选

    类型

    说明

    errorMessage

    String

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

    errorCode

    String

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

    data

    Json

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

  • 请求成功响应样例
    Http Status Code: 200
    
    {
        "data": {
            "runtime": 0.775425022,
            "vertices": [
                {
                    "id": "Vivian",
                    "label": "user",
                    "properties": {
                        "Occupation": [
                            "artist"
                        ],
                        "Name": [
                            "薇薇安"
                        ],
                        "Zip-code": [
                            "98133"
                        ],
                        "Gender": [
                            "F"
                        ],
                        "Age": [
                            "25-34"
                        ]
                    }
                },
                ......
            ]
        }
    }
  • 请求失败样例
    Http Status Code: 400
    {
        "errorMessage": "org.apache.tinkerpop.gremlin.driver.exception.ResponseException: No such property: g1 for class: Script4",
        "errorCode": "GES.8503"
    }

返回值

  • 正常

    200

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

    返回值

    说明

    400 Bad Request

    请求错误。

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。