Service Plane API Overview

GES service plane APIs cover vertex operations, edge operations, metadata operations, Gremlin operations, algorithms, paths, graph statistics, subgraph operations, and job management.

Table 1 Vertex operation APIs

Parameter

Version

URL

Function

Querying Vertices That Meet Filter Criteria

1.0.0

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

Query vertices based on a filtering criterion. For example, if the vertex metadata contains the age property, the filter criterion can be 'age > 18'.

Querying Vertex Details

1.0.0

GET/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/detail?vertexIds={vertex_ids}

Query details about a specified vertex of a specified set of vertices, including the label information.

Adding a Vertex

1.0.6

POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices

Add a vertex.

Deleting a Vertex

1.0.6

DELETE/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}

Delete a vertex.

Updating Vertex Properties

1.1.6

POST/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}/properties/action?action_id={actionId}

Modify a vertex's properties, including adding, changing, and deleting properties.

Querying Vertex Data in Batches

1.1.9

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

Query vertex details in batches.

Adding Vertices in Batches

2.1.16

POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-add

Add vertices in batches.

Deleting Vertices in Batches

2.1.9

POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-delete

Delete vertices in batches based on the vertex IDs.

Updating Vertex Properties in Batches

2.1.10

POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/properties/action?action_id={actionId}

Update vertex properties in batches.

Adding a Vertex Label

1.1.6

POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}/labels

Add a vertex label.

Deleting a Vertex Label

1.1.6

DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}/labels/{label_name}

Delete a vertex label.

Exporting Filtered Vertices

2.2.7

POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=export

Export the vertex set that meets the filter criteria.

Deleting Filtered Vertices

2.2.7

POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=delete

Delete the vertex set that meets the filter criteria.

Table 2 Edge operation APIs

Parameter

Version

URL

Function

Querying Edges That Meet Filter Criteria

1.0.0

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

Filter the edges that meet the filter criteria of edge properties.

Querying Edge Details

1.0.0

GET /ges/v1.0/{project_id}/graphs/{graph_name}/edges/detail?source={sourceVertex}&target={targetVertex}&index={index}

Query the details about an edge based on its source and target vertices, including the edge's label information.

Adding an Edge

1.0.6

POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges

Add an edge.

Deleting an Edge

1.0.6

DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/edges?source={sourceVertex}&target={targetVertex}&index={index}

Delete an edge.

Updating Edge Properties

1.1.6

POST/ges/v1.0/{project_id}/graphs/{graph_name}/edges/properties/action?action_id={actionId}&source={sourceVertex}&target={targetVertex}&index={index}

Modify an edge's properties, including adding, changing, and deleting properties.

Querying Edge Data in Batches

1.1.6

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

Query edge details in batches.

Adding Edges in Batches

2.1.16

POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-add

Add edges in batches.

Deleting Edges in Batches

2.1.9

POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-delete

Delete edges in batches based on the source vertices, target vertices, and indexes of the edges.

Updating Edge Properties in Batches

2.1.10

POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/properties/action?action_id={actionId}

Update edge properties in batches.

Exporting Filtered Edges

2.2.7

POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=export

Export the edge set that meets the filter criteria.

Deleting Filtered Edges

2.2.7

POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=delete

Delete the edge set that meets the filter criteria.

Table 3 Metadata operation APIs

Parameter

Version

URL

Function

Adding a Label

1.1.6

POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels

Add a label.

Adding a Vertex Label

1.1.6

POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}/labels

Add a vertex label.

Querying Graph Metadata Details

1.0.0

GET /ges/v1.0/{project_id}/graphs/{graph_name}/schema

Query metadata details.

Table 4 Index operation APIs

Parameter

Version

URL

Function

Creating an Index

1.1.6

POST /ges/v1.0/{project_id}/graphs/{graph_name}/indices

Create an index.

Deleting an Index

1.1.6

DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/indices/{indexName}

Delete an index.

Querying Indexes

1.1.6

GET /ges/v1.0/{project_id}/graphs/{graph_name}/indices

Query indexes.

Table 5 Gremlin operation APIs

Parameter

Version

URL

Function

Executing Gremlin Queries

1.0.0

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

Execute Gremlin queries.

Table 6 Algorithm APIs

Parameter

Version

URL

Function

Running Algorithms

1.0.0

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

Run algorithms.

Table 7 Path APIs

Parameter

Version

URL

Function

Querying Path Details

1.1.6

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

Query the path details.

Table 8 Graph statistics APIs

Parameter

Version

URL

Function

Querying General Information About a Graph

1.0.0

GET /ges/v1.0/{project_id}/graphs/{graph_name}/summary

Query general information about a graph.

Querying the Graph Version

2.0.0

GET /ges/v1.0/{project_id}/graphs/{graph_name}/version

Query the graph version.

Table 9 Subgraph operation APIs

Parameter

Version

URL

Function

Querying a Subgraph

2.1.13

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

Queries the subgraphs formed by the entered vertices and edges between the vertices.

Table 10 Job management APIs

Parameter

Version

URL

Function

Querying Job Status

1.0.0

GET/ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}/status?offset=offset&limit=limit

Query job status.

Canceling a Job

1.0.0

DELETE https://Endpoint/ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}

Cancel a job.

Exporting Job Execution Results to Files

2.2.1

POST /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}/action?action_id=export-result

Export the execution result (result) of an asynchronous job (job_id) to a file.

Querying the Job List

2.2.13

GET /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/status?limit={limit}&offset={offset}

After the ID of an asynchronous job is returned, if the job ID at the service layer is lost and cannot be obtained through the API, a new API is provided to query all asynchronous jobs stored in the engine. The job ID, job status, and original request of each job are returned.

Table 11 Other service plane APIs

Parameter

Version

URL

Function

Filtered-query API

2.2.15

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

Filter the k-hop process layer by layer, and list the k-hop vertices or edges that meet the filter criteria.

Updating Specified Properties of Vertices and Edges by Importing a File

2.2.13

POST /v1.0/{project_id}/graphs/{graph_name}/action?action_id=import-properties

Update specified properties of vertices and edges by importing a file.