文档首页/图引擎服务 GES/API参考/业务面API/内存版/Gremlin操作API/执行Gremlin查询(1.0.0)
更新时间：2025-12-19 GMT+08:00
查看PDF
分享

执行Gremlin查询(1.0.0)

功能介绍

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

URI

POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-gremlin-query
表1 路径参数

参数

是否必选

类型

说明

project_id

是

String

参数解释：

项目编号。获取方法，请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母和数字组成，且长度为[1-64]个字符。

默认取值：

不涉及。

graph_name

是

String

图名称。

请求参数

表2 Body参数说明

参数

是否必选

类型

说明

command

是

String

查询命令(Gremlin语言)。

响应参数

表3 响应Body参数说明

参数

类型

说明

errorMessage

String

参数解释：

系统提示信息。

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

取值范围：

不涉及。

errorCode

String

参数解释：

系统提示信息。

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

取值范围：

不涉及。

data

Object

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

请求示例

执行Gremlin查询操作，输入的查询命令为g.V().limit(100)表示查询所有点，但限制点的返回数量为100。

POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-gremlin-query
{       
    "command":"g.V().limit(100)" 
}

响应示例

状态码： 200

成功响应示例

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"
                    ]
                }
            },
            ......
        ]
    }
}

状态码： 400

失败响应示例

Http Status Code: 400
{
    "errorMessage": "org.apache.tinkerpop.gremlin.driver.exception.ResponseException: No such property: g1 for class: Script4",
    "errorCode": "GES.8503"
}

状态码

返回值

说明

400 Bad Request

请求错误。

401 Unauthorized

鉴权失败。

403 Forbidden

没有操作权限。

404 Not Found

找不到资源。

500 Internal Server Error

服务内部错误。

503 Service Unavailable

服务不可用。

错误码

请参见错误码。

父主题：Gremlin操作API