Management Plane API

Querying Quotas

1.0.0

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.

Listing Graphs

2.1.18

GET /v2/{project_id}/graphs

Query the list of all created graphs.

Querying Graph Details

1.0.0

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

2.2.2

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

1.0.0

POST /v2/{project_id}/graphs/{graph_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 /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

1.0.0

DELETE /v2/{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 into a Graph

2.1.14

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

You need to incrementally import graph data in batches.

Exporting a Graph

1.0.5

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

2.1.2

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.

Upgrading a Graph

1.0.5

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

1.0.6

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

1.0.6

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.

Changing Graph Size

2.2.21

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

Change the graph size.

Forcibly Restarting a Graph

2.2.21

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

This API is used to forcibly start a graph.

Expanding a Graph

2.2.23

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.

Viewing the List of All Backups

1.0.0

GET /v2/{project_id}/graphs/backups

View all backup details of all graphs.

Viewing the Backup List of a Graph

1.0.0

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

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

Creating a Backup

1.0.0

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

1.0.0

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

Delete backups of a graph.

Exporting a Backup

2.3.16

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

Export a GES graph instance backup to OBS.

Importing a Backup

2.3.16

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

Import a GES graph instance backup from OBS.

Listing Metadata

1.0.2

GET /v2/{project_id}/graphs/metadatas

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

Querying Metadata

1.0.2

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

Query details about a graph metadata file.

Creating a Metadata File

2.1.18

POST /v2/{project_id}/graphs/metadatas

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

Deleting a Metadata File

1.0.2

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

Delete a metadata file.

Importing Metadata from OBS

1.0.0

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

This API is used to import metadata from OBS.

Querying Job Status

1.0.0

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 Task Center

1.1.8

GET /v2/{project_id}/graphs/jobs

View all asynchronous jobs.

Querying Scene Analysis Plugin Information

2.3.11

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

2.3.11

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

Subscribe to a scene analysis plugin so that you can use the function through the service plane APIs.

Unsubscribing from a Scene Analysis Plugin

2.3.11

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

Unsubscribe from a scene analysis plugin. After the subscription is canceled, you cannot use the function through application service plane APIs.