Management Plane API Overview
GES management plane APIs cover aspects of system management, graph management, backup management, metadata management, and task center.
| Parameter | Version | URL | Function |
|---|---|---|---|
| Viewing Quotas | 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 | 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. |
| Parameter | Version | URL | Function |
|---|---|---|---|
| Querying the Graph List | GET /v1.0/{project_id}/graphs?offset={offset}&limit={limit} | Query the list of all created graphs. | |
| Querying Graph Details | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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. |
| Parameter | Version | URL | Function |
|---|---|---|---|
| Viewing the List of All Backups | 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 | 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 | 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 | DELETE/v1.0/{project_id}/graphs/{graph_id}/backups/{backup_id} | Delete backups of a graph. |
| Parameter | Version | URL | Function |
|---|---|---|---|
| Querying the Metadata List | 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 | GET/v1.0/{project_id}/graphs/metadatas/{metadata_id} | Query details about a graph metadata file. | |
| Adding Metadata | 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 | DELETE/v1.0/{project_id}/graphs/metadatas/{metadata_id} | Delete a metadata file. |
| Parameter | Version | URL | Function |
|---|---|---|---|
| Querying Job Status | 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 | GET /v1.0/{project_id}/graphs/jobs?offset={offset}&limit={limit} | View all asynchronous jobs. |
Last Article: API Overview
Next Article: Service Plane API Overview
Did this article solve your problem?
Thank you for your score!Your feedback would help us improve the website.