Before You Start

Welcome to Graph Engine Service API Reference. Graph Engine Service (GES) is the industry's first commercially available, independently developed distributed native graph engine. It provides services for querying and analyzing graph-structured data based on relationships. It is extensively applied in scenarios with abundant relational data, such as social applications, corporate relationship analysis, risk control, recommendations, public sentiment monitoring, and fraud prevention.

You can use the APIs provided in this document to perform various operations on GES resources.

Management plane APIs
Management plane APIs offer functions for graph management, including creation, stopping, startup, restoration, upgrade, import, export, and data clearance, EIP binding and unbinding, backup creation, query, deletion, and metadata management. You need to call these APIs when performing such operations.
Service plane APIs
Service plane APIs deliver service-related functions for graphs, including addition, deletion, query, and modification of vertices, edges, and metadata, execution of Gremlin queries, and algorithm runs. You need to call these APIs when performing such operations.

For a comprehensive list of all APIs supported by GES, refer to Management Plane APIs and Memory Edition.

Prior to calling GES APIs, make sure you have a thorough understanding of GES concepts. Detailed information can be found in the Service Overview.

Endpoints

An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.

Concepts

Account
An account is created when you successfully sign up for Huawei Cloud. An account has full access permissions for all the resources and cloud services. It can be used to reset user passwords and grant users permissions. The account is a payment entity. For security purposes, do not directly use the account to perform routine management. Instead, create IAM users and grant them permissions for routine management.
User
A user is created in IAM to use cloud services. Each user has its own identity credentials (password and access keys).

The account name, username, and password will be required for API authentication.
Region
A region is a geographic area where cloud services are deployed. Availability zones (AZs) in the same region can communicate with each other over an intranet, while AZs in different regions are isolated from each other. By creating cloud resources in various regions, you can design applications to better meet the needs of specific customers or to comply with legal or other regional requirements.
AZ
An availability zone (AZ) consists of one or more physical data centers. Within an AZ, compute, networking, storage, and other resources are logically partitioned into multiple clusters. Multiple AZs within a region are connected via high-speed fiber optics to meet user needs for building cross-AZ high-availability systems.
Project
Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each Huawei Cloud region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. If you desire more granular permission controls, you can create sub-projects under the default regional project, purchase resources within these sub-projects, and authorize them accordingly. This ensures that users can only access resources from particular sub-projects, thereby enhancing precision in resource authorization management.

Figure 1 Project isolating model
Enterprise project
Enterprise projects group and manage resources across regions. Resources in enterprise projects are logically isolated from each other. An enterprise project can include resources from multiple regions, and resources can be added to or removed from enterprise projects.

For details about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.