Help Center/ Graph Engine Service/ API Reference/ API Overview/ Service Plane API/ Database Edition
Updated on 2025-08-22 GMT+08:00
View PDF
Share

Database Edition

Database edition service plane APIs include vertex operations, edge operations, metadata operations, index operations, HyG dataset management, HyG algorithm, algorithms, graph statistics, graph operations, job management, and Cypher operations.

Table 1 Vertex operation APIs

API

Start Version

URL

Function

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.

Batch Querying Vertex Data

1.1.9

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

Query vertex details in batches.

Batch Adding Vertices

2.1.16

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

Add vertices in batches.

Batch Deleting Vertices

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.

Batch Updating Vertex Properties

2.1.10

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

Update vertex properties in batches.
Table 2 Edge operation APIs

API

Start Version

URL

Function

Querying Edge Details

1.0.0

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

Query detailed information about an edge based on its source vertex, target vertex, and index, and return the labels and properties on the edge.

Batch Querying Edge Data

1.1.6

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

Query edge details in batches.

Batch Adding Edges

2.1.16

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

Add edges in batches.

Batch Deleting Edges

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.

Batch Updating Edge Properties

2.1.10

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

Update edge properties in batches.
Table 3 Metadata operation APIs

API

Start Version

URL

Function

Adding a Label

1.1.6

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

Add a label.

Updating a Label

1.1.7

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

Update a label.

Querying Graph Metadata Details

1.0.0

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

Query metadata details.

Querying Labels

2.2.18

GET /ges/v1.0/{project_id}/graphs/{graph_name}/schema?label={labelName}

Query labels.
Table 4 Index operation APIs

API

Start 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 Native algorithm API

API

Start Version

URL

Function

Runing Algorithms

1.0.0

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

Run native algorithms.
Table 6 Graph statistics APIs

API

Start Version

URL

Function

Querying General Information About a Graph

1.0.0

GET /ges/v1.0/{project_id}/graphs/{graph_name}/summary?label_details={labelDetails}

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 7 Graph operation APIs

API

Start Version

URL

Function

Importing a Graph

2.1.14

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

Import graph data.

Clearing a Graph

2.1.2

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

Clear graph data.
Table 8 Job management APIs

API

Start 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 the job status.

Querying the Job List

2.2.13

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

Query all asynchronous jobs saved in the engine and return the ID, status, and original request of each job.
Table 9 Cypher operation APIs

API

Start Version

URL

Function

Cypher Operation APIs

2.2.16

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.
Table 10 Interactive transaction APIs

API

URL

Function

Creating a Transaction

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

Create a transaction.

Executing Transaction Cypher Statements

POST /ges/v1.0/{project_id}/graphs/{graph_name}/transaction/{commit}

Execute transaction Cypher statements.

Committing a Transaction

POST /ges/v1.0/{project_id}/graphs/{graph_name}/transaction/{commit}/commit

Commit a transaction.

Rolling Back a Transaction

DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/transaction/{commit}

Roll back a transaction.
Table 11 O&M monitoring APIs

API

URL

Function

Viewing Monitoring Metrics

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

Query the job status.

Viewing Real-Time Requests

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

Query all asynchronous jobs saved in the engine and return the ID, status, and original request of each job.
Parent topic: Service Plane API