Help Center> Graph Engine Service> API Reference> API Overview> Management Plane API Overview

Management Plane API Overview

GES management plane APIs cover aspects of system management, graph management, backup management, metadata management, and task center.

Table 1 System management APIs

Parameter

Version

URL

Function

Viewing Quotas

1.0.0

GET /v1.0/{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.

Verifying Metadata Files

1.0.0

POST /v1.0/{project_id}/graphs/action?action_id=check-schema

Verify whether the metadata file matches the vertex and edge data sets. When creating a graph with initial data or incrementally importing data to a graph, you can call this API to check whether the vertex and edge data sets match the metadata.

Table 2 Graph management APIs

Parameter

Version

URL

Function

Querying the Graph List

2.1.18

GET /v1.0/{project_id}/graphs?offset={offset}&limit={limit}

Query the list of all created graphs.

Querying Graph Details

1.0.0

GET /v1.0/{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

2.2.2

POST /v1.0/{project_id}/graphs

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

Stopping a Graph

1.0.0

POST/v1.0/{project_id}/graphs/{graph_id}/action?action_id=stop

You can stop a graph at any time because service continuity is not required. The graph will not be charged after it is stopped.

Starting a Graph

1.0.0

POST /v1.0/{project_id}/graphs/{graph_id}/action?action_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

1.0.0

DELETE /v1.0/{project_id}/graphs/{graph_id}

Delete a graph when you do not need it. The graph will not be charged after it is deleted.

Incrementally Importing Data to Graphs

2.1.14

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

You need to incrementally import graph data in batches.

Exporting a Graph

1.0.5

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

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

Clearing a Graph

2.1.2

POST /v1.0/{project_id}/graphs/{graph_id}/action?action_id=clear-graph&clear-metadata={clearMetadata}

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

1.0.5

POST /v1.0/{project_id}/graphs/{graph_id}/action?action_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 EIPs

1.0.6

POST /v1.0/{project_id}/graphs/{graph_id}/action?action_id=bindEip

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

Unbinding EIPs

1.0.6

POST /v1.0/{project_id}/graphs/{graph_id}/action?action_id=unbindEip

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

Table 3 Backup management APIs

Parameter

Version

URL

Function

Viewing the List of All Backups

1.0.0

GET /v1.0/{project_id}/graphs/backups?offset={offset}&limit={limit}

View all backup details of all graphs.

Viewing the Backup List of a Graph

1.0.0

GET/v1.0/{project_id}/graphs/{graph_id}/backups?offset={offset}&limit={limit}

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

Adding a Backup

1.0.0

POST/v1.0/{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 backups

1.0.0

DELETE/v1.0/{project_id}/graphs/{graph_id}/backups/{backup_id}

Delete backups of a graph.

Table 4 Metadata management APIs

Parameter

Version

URL

Function

Querying the Metadata List

1.0.2

GET /v1.0/{project_id}/graphs/metadatas?offset={offset}&limit={limit}

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

Querying Metadata

1.0.2

GET/v1.0/{project_id}/graphs/metadatas/{metadata_id}

Query details about a graph metadata file.

Adding Metadata

2.1.18

POST /v1.0/{project_id}/graphs/metadatas

Adding metadata is a preparation operation before creating a graph. You must create metadata before creating the graph.

Deleting Metadata

1.0.2

DELETE/v1.0/{project_id}/graphs/metadatas/{metadata_id}

Delete a metadata file.

Table 5 Task center APIs

Parameter

Version

URL

Function

Querying Job Status

1.0.0

GET/v1.0/{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 the Task Center

1.1.8

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

View all asynchronous jobs.