このページは、お客様の言語ではご利用いただけません。Huawei Cloudは、より多くの言語バージョンを追加するために懸命に取り組んでいます。ご協力ありがとうございました。

Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
Software Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
On this page

Show all

Management Plane APIs

Updated on 2024-12-03 GMT+08:00

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

Table 1 System management APIs

Parameter

Version

URL

Function

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.

Table 2 Graph management APIs

Parameter

Version

URL

Function

Listing Graphs

2.1.18

GET /v2/{project_id}/graphs

List 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.

NOTE:

The metadata will not be cleared.

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.

Resizing a Graph

2.2.21

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

Resize a graph.

Forcibly Restarting a Graph

2.2.21

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

Forcibly start a graph.

Expanding a Graph

2.2.23

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

Dynamically resize multiple secondary nodes to enable concurrent handling of increased read requests.

Table 3 Backup management APIs

Parameter

Version

URL

Function

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.

Table 4 Metadata management APIs

Parameter

Version

URL

Function

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

Import metadata from OBS.

Table 5 Task center APIs

Parameter

Version

URL

Function

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.

Table 6 Plugin management APIs

API

Version

URL

Function

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.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback