Executing Gremlin Queries (1.0.0)

Function

This API is used to return the query result of a Gremlin statement.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
graph_name	Yes	String	Graph name

Request Parameters

**Table 2** Request body parameter
Parameter	Mandatory	Type	Description
command	Yes	String	Query command (Gremlin language)

Response Parameters

**Table 3** Response body parameters
Parameter	Type	Description
errorMessage	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.
errorCode	String	System prompt code. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
data	Object	Query results. This parameter is left blank when the request fails.

Example Request

Perform the Gremlin query operation. If the query command is g.V().limit(100), all vertices are queried, but the number of returned vertices is limited to 100.

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

SERVER_URL: Address for accessing a graph. For details about its value, see Using Service Plane APIs.
The size of the request body cannot exceed 64 MB.

Example Response

Status code: 200

Example response for a successful request

Http Status Code: 200

{
    "data": {
        "runtime": 0.775425022,
        "vertices": [
            {
                "id": "Vivian",
                "label": "user",
                "properties": {
                    "Occupation": [
                        "artist"
                    ],
                    "Name": [
                        "Vivian"
                    ],
                    "Zip-code": [
                        "98133"
                    ],
                    "Gender": [
                        "F"
                    ],
                    "Age": [
                        "25-34"
                    ]
                }
            },
            ......
        ]
    }
}

Status code: 400

Example response for a failed request

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

Status Code

Return Value	Description
400 Bad Request	Request error.
401 Unauthorized	Authorization failed.
403 Forbidden	No operation permissions.
404 Not Found	No resources found.
500 Internal Server Error	Internal server error.
503 Service Unavailable	Service unavailable.