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

Management Plane APIs

GES management plane APIs comprise APIs for system management, graph management, backup management, metadata management, task center, and plugin management.

Table 1 System management APIs

Parameter

URL

Function

Querying Quotas

GET /v2/{project_id}/graphs/quotas

Query the quota of graphs, edges, or backups. When creating or backing up a graph, you can call this API to view the quota.

Table 2 Graph management APIs

Parameter

URL

Function

Querying the Graph List

GET /v2/{project_id}/graphs

Query the list of all created graphs.

Querying Graph Details

GET /v2/{project_id}/graphs/{graph_id}

Query details about a graph, including the graph's private and public access addresses, version number, and imported vertex and edge data sets.

Creating a Graph

POST /v2/{project_id}/graphs

Create a graph after you define the metadata and vertex and edge data sets of the graph.

Stopping a Graph

POST /v2/{project_id}/graphs/{graph_id}/stop

You can stop a graph at any time because service continuity is not required.

Starting a Graph

POST /v2/{project_id}/graphs/{graph_id}/start

If you want to use a stopped graph, you can restore the data to the state it was before the shutdown or to a backup time point.

Deleting a Graph

DELETE /v2/{project_id}/graphs/{graph_id}

Delete a graph when you do not need it.

Incrementally Importing Data to a Graph

POST /v2/{project_id}/graphs/{graph_id}/import-graph

You need to incrementally import graph data in batches.

Exporting a Graph

POST /v2/{project_id}/graphs/{graph_id}/export-graph

You need to export all the data in a graph as a text file.

Clearing a Graph

POST /v2/{project_id}/graphs/{graph_id}/clear-graph

You need to clear all the data in a graph, including the vertex and edge data.

NOTE:

The metadata will not be cleared.

Upgrading a Graph

POST /v2/{project_id}/graphs/{graph_id}/upgrade

If bugs are detected in a graph of the early version or new functions need to be added, you need to upgrade the graph to the new version.

Binding an EIP

POST /v2/{project_id}/graphs/{graph_id}/bind-eip

To access a graph over the public network, you need to bind an EIP.

Unbinding an EIP

POST /v2/{project_id}/graphs/{graph_id}/unbind-eip

You can unbind an EIP from a graph if you no longer need to access the graph over the public network.

Resizing a Graph

POST /v2/{project_id}/graphs/{graph_id}/resize

Resize a graph instance.

Forcibly Restarting a Graph

POST /v2/{project_id}/graphs/{graph_id}/restart

Forcibly start a graph.

Expanding a Graph

POST /v2/{project_id}/graphs/{graph_id}/expand

This API is used to expand multiple secondary nodes dynamically. The expanded secondary nodes can process read requests, improving read performance.

Table 3 Backup management APIs

Parameter

URL

Function

Viewing the List of All Backups

GET /v2/{project_id}/graphs/backups

View all backup details of all graphs.

Viewing the Backup List of a Graph

GET /v2/{project_id}/graphs/{graph_id}/backups

View details about all backups of a graph, including the backup start time and end time.

Adding a Backup

POST /v2/{project_id}/graphs/{graph_id}/backups

Backup is used to improve data reliability. It can also be used as a snapshot of a graph for you to restore data when necessary.

Deleting a Backup

DELETE /v2/{project_id}/graphs/{graph_id}/backups/{backup_id}

Delete backups of a graph.

Exporting a Backup

POST /v2/{project_id}/graphs/{graph_id}/backups/export

Export a GES graph instance backup to OBS.

Importing a Backup

POST /v2/{project_id}/graphs/{graph_id}/backups/import

Import a GES graph instance backup from OBS.

Table 4 Metadata management APIs

Parameter

URL

Function

Querying the Metadata List

GET /v2/{project_id}/graphs/metadatas

Query details about all metadata files, including the status and OBS storage path.

Querying Metadata

GET /v2/{project_id}/graphs/metadatas/{metadata_id}

Query details about a graph metadata file.

Adding Metadata

POST /v2/{project_id}/graphs/metadatas

Add metadata to prepare for creating a graph.

Deleting Metadata

DELETE /v2/{project_id}/graphs/metadatas/{metadata_id}

Delete a metadata file.

Importing Metadata from OBS

POST /v2/{project_id}/graphs/metadata/upload-from-obs

Import metadata from OBS.

Table 5 Task center APIs

Parameter

URL

Function

Querying the Job Status

GET /v2/{project_id}/graphs/{graph_id}/jobs/{job_id}/status

Graph deleting, stopping, starting, restoring, incrementally importing, clearing, and upgrading are asynchronous jobs initialized by calling these APIs. These APIs return the job IDs. You can view the execution status of each asynchronous job through the corresponding API.

Querying Job Details in the Job Center

GET /v2/{project_id}/graphs/jobs

View all asynchronous jobs.

Table 6 Plugin management APIs

API

URL

Function

Querying Scene Analysis Plugin Information

GET /v2/{project_id}/graphs/scenes

Query information about the application analysis capability in a scene, including information about the applications, parameters, and function details.

Subscribing to a Scene Analysis Plugin

POST /v2/{project_id}/graphs/{graph_id}/scenes/register

This API is used to subscribe to a scene analysis plugin so that you can use the function through the service plane APIs.

Unsubscribing from a Scene Analysis Plugin

POST /v2/{project_id}/graphs/{graph_id}/scenes/unregister

This API is used to unsubscribe from a scene analysis plugin. After the subscription is canceled, you cannot use the function through application service plane APIs.