Updated on 2025-03-05 GMT+08:00

Memory Edition

Memory edition service plane APIs cover vertex operations, edge operations, metadata operations, index operations, Gremlin operations, algorithms, paths, graph statistics, graph and subgraph operations, job management, and Cypher operations.

Table 1 Vertex operation APIs

API

URL

Function

Querying Vertices That Meet Filter Criteria

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

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

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

Add a vertex.

Deleting a Vertex

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

Delete a vertex.

Updating Vertex Properties

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

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

Query vertex details in batches.

Adding Vertices in Batches

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

Add vertices in batches.

Deleting Vertices in Batches

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

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

Update vertex properties in batches.

Adding a Vertex Label

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

Add a vertex label.

Deleting a Vertex Label

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

Delete a vertex label.

Exporting Filtered Vertices

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

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

API

URL

Function

Querying Vertices That Meet Filter Criteria

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

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

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

Add an edge.

Deleting an Edge

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

Delete an edge.

Updating Edge Properties

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

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

Query edge details in batches.

Adding Edges in Batches

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

Add edges in batches.

Deleting Edges in Batches

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

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

Update edge properties in batches.

Exporting Filtered Edges

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

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

API

URL

Function

Adding a Label

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

Add a label.

Updating a Label

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

Update a label.

Querying Graph Metadata Details

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

Query metadata details.

Deleting a Label

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

Delete a label as well as the vertices and edges associated with the label.

Adding Labels in Batches

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

Add labels in batches.

Querying a Schema

GET /ges/v1.0/{project_id}/graphs/{graph_name}/schema/structure?detail={details}

Query a generated schema (obtained from OBS).

Generating a Schema

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

Generate a schema where labels are represented with vertices and the relationship between the labels are represented with edges, and store the schema in an OBS bucket.

Generating Data Assets

POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema/data-assets

Generate data assets.

Obtaining Data Assets

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

Obtain data assets.

Table 4 Index operation APIs

API

URL

Function

Creating an Index

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

Create an index.

Deleting an Index

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

Delete an index.

Querying Indexes

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

Query indexes.

Table 5 Gremlin operation APIs

API

URL

Function

Executing Gremlin Queries

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

Execute Gremlin queries.

Table 6 Algorithm APIs

Operation

URL

Function

Runing Algorithms

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

Run algorithms.

Table 7 Temporal graph APIs

API

URL

Function

Community Evolution (temporal_graph)

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

The community evolution algorithm generates a temporal graph that shows structure changes of a community over time.

Temporal BFS (temporal_bfs)

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

This algorithm searches for associated vertices based on temporal message passing and temporal BFS algorithms, and outputs the visit time of each vertex and the distance from the vertex to the source start vertex.

Temporal Paths

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

Execute the temporal paths algorithm based on input parameters. Only one temporal path that meets the conditions is returned between two vertices.

Table 8 Path APIs

Parameter

URL

Function

Querying Path Details

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

Query the path details.

Querying Tree Details

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

After you input a vertex, a tree starting from the vertex is output, including nodes and edges in the tree, and information about reachable paths. Parameters can be the direction (out, in, and out and in), maximum number of hops, and edge properties to be filtered.

Repeat-query API

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

Cyclically perform traversal query based on certain exit conditions.

Table 9 Graph statistics APIs

Operation

URL

Function

Querying General Information About a Graph

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

Query general information about a graph.

Querying the Graph Version

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

Query the graph version.

Table 10 Graph operation APIs

Operation

URL

Function

Importing a Graph

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

Import data.

Exporting a Graph

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

Export data.

Clearing a Graph

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

Clear data.

Table 11 Subgraph operation APIs

Operation

URL

Function

Querying a Subgraph

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

Query the subgraphs that are created by the specified vertices and the edges connecting them.

Executing an Algorithm on a Subgraph

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

Adjust the subgraph creation type based on the input and execute an algorithm on the generated subgraph.

Table 12 Job management APIs

Operation

URL

Function

Querying Task Status

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

Query job status.

Canceling a Job

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

Cancel a job.

Exporting Job Execution Results to Files

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

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 13 Custom operations APIs

API

URL

Function

Performing Custom Operations

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

Query the job status.

Table 14 Fine-grained permission control APIs

API

URL

Function

Granting Permissions

POST /ges/v1.0/{project_id}/graphs/{graph_name}/rbac/action?action_id=grant

Grant fine-grained permissions.

Revoking Permissions

POST /ges/v1.0/{project_id}/graphs/{graph_name}/rbac/action?action_id=revoke

Revoke permissions.

Querying Permissions

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

Query all label and property permissions of the current user.

Table 15 O&M monitoring APIs

API

URL

Function

Viewing Monitoring Metrics

GET /ges/v1.0/{project_id}/graphs/{graph_name}/om/metrics?real_time=&with_performance_metrics=

View monitoring metrics, including node metrics and graph instance performance monitoring metrics.

Viewing Real-Time Requests

GET/ges/v1.0/{project_id}/graphs/{graph_name}/om/real-time-queries?summary=

View the real-time requests on the current primary node.

Table 16 Other service plane APIs

Operation

URL

Function

Cypher Operation APIs

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

Run Cypher statements to query data in GES and obtain results.

Filtered-query API

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.

Filtered-query V2

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

This is a new version of the Filtered Query API. This API supports both Filtered Query and Repeat Query functions.

Domain-Specific Language (DSL) Query APIs

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

Provide flexible and controllable DSLs to help users design and run algorithms at low costs.

Updating Specified Properties of Vertices and Edges by Importing a File

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

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

Deleting Vertices and Edges by Reading the Files

POST /v1.0/{project_id}/graphs/{graph_name}/action?action_id=delete-by-file

Delete vertices and edges by reading the files.