Service Plane API Overview
GES service plane APIs cover vertex operations, edge operations, metadata operations, Gremlin operations, algorithms, paths, graph statistics, subgraph operations, and job management.
| Parameter | Version | URL | Function |
|---|---|---|---|
| Querying Vertices That Meet Filter Criteria | POST/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=query | Query vertices based on a filtering criterion. For example, if the vertex metadata contains the age property, the filter criterion can be 'age > 18'. | |
| Querying Vertex Details | GET/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/detail?vertexIds={vertex_ids} | Query details about a specified vertex of a specified set of vertices, including the label information. | |
| Adding a Vertex | POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices | Add a vertex. | |
| Deleting a Vertex | DELETE/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id} | Delete a vertex. | |
| Updating Vertex Properties | POST/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}/properties/action?action_id={actionId} | Modify a vertex's properties, including adding, changing, and deleting properties. | |
| Querying Vertex Data in Batches | POST/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-query | Query vertex details in batches. | |
| Adding Vertices in Batches | POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-add | Add vertices in batches. | |
| Deleting Vertices in Batches | POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-delete | Delete vertices in batches based on the vertex IDs. | |
| Updating Vertex Properties in Batches | POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/properties/action?action_id={actionId} | Update vertex properties in batches. | |
| Adding a Vertex Label | POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}/labels | Add a vertex label. | |
| Deleting a Vertex Label | DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}/labels/{label_name} | Delete a vertex label. | |
| Exporting Filtered Vertices | POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=export | Export the vertex set that meets the filter criteria. | |
| Deleting Filtered Vertices | POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=delete | Delete the vertex set that meets the filter criteria. |
| Parameter | Version | URL | Function |
|---|---|---|---|
| Querying Edges That Meet Filter Criteria | POST/ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=query | Filter the edges that meet the filter criteria of edge properties. | |
| Querying Edge Details | GET /ges/v1.0/{project_id}/graphs/{graph_name}/edges/detail?source={sourceVertex}&target={targetVertex}&index={index} | Query the details about an edge based on its source and target vertices, including the edge's label information. | |
| Adding an Edge | POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges | Add an edge. | |
| Deleting an Edge | DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/edges?source={sourceVertex}&target={targetVertex}&index={index} | Delete an edge. | |
| Updating Edge Properties | POST/ges/v1.0/{project_id}/graphs/{graph_name}/edges/properties/action?action_id={actionId}&source={sourceVertex}&target={targetVertex}&index={index} | Modify an edge's properties, including adding, changing, and deleting properties. | |
| Querying Edge Data in Batches | POST/ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-query | Query edge details in batches. | |
| Adding Edges in Batches | POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-add | Add edges in batches. | |
| Deleting Edges in Batches | POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-delete | Delete edges in batches based on the source vertices, target vertices, and indexes of the edges. | |
| Updating Edge Properties in Batches | POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/properties/action?action_id={actionId} | Update edge properties in batches. | |
| Exporting Filtered Edges | POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=export | Export the edge set that meets the filter criteria. | |
| Deleting Filtered Edges | POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=delete | Delete the edge set that meets the filter criteria. |
| Parameter | Version | URL | Function |
|---|---|---|---|
| Adding a Label | POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels | Add a label. | |
| Adding a Vertex Label | POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}/labels | Add a vertex label. | |
| Querying Graph Metadata Details | GET /ges/v1.0/{project_id}/graphs/{graph_name}/schema | Query metadata details. |
| Parameter | Version | URL | Function |
|---|---|---|---|
| Creating an Index | POST /ges/v1.0/{project_id}/graphs/{graph_name}/indices | Create an index. | |
| Deleting an Index | DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/indices/{indexName} | Delete an index. | |
| Querying Indexes | GET /ges/v1.0/{project_id}/graphs/{graph_name}/indices | Query indexes. |
| Parameter | Version | URL | Function |
|---|---|---|---|
| Executing Gremlin Queries | POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-gremlin-query | Execute Gremlin queries. |
| Parameter | Version | URL | Function |
|---|---|---|---|
| Running Algorithms | POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-algorithm | Run algorithms. |
| Parameter | Version | URL | Function |
|---|---|---|---|
| Querying Path Details | POST /ges/v1.0/{project_id}/graphs/{graph_name}/paths/action?action_id=query-detail | Query the path details. |
| Parameter | Version | URL | Function |
|---|---|---|---|
| Querying General Information About a Graph | GET /ges/v1.0/{project_id}/graphs/{graph_name}/summary | Query general information about a graph. | |
| Querying the Graph Version | GET /ges/v1.0/{project_id}/graphs/{graph_name}/version | Query the graph version. |
| Parameter | Version | URL | Function |
|---|---|---|---|
| Querying a Subgraph | POST/ges/v1.0/{project_id}/graphs/{graph_name}/subgraphs/action?action_id=query | Queries the subgraphs formed by the entered vertices and edges between the vertices. |
| Parameter | Version | URL | Function |
|---|---|---|---|
| Querying Job Status | GET/ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}/status?offset=offset&limit=limit | Query job status. | |
| Canceling a Job | DELETE https://Endpoint/ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id} | Cancel a job. | |
| Exporting Job Execution Results to Files | POST /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}/action?action_id=export-result | Export the execution result (result) of an asynchronous job (job_id) to a file. | |
| Querying the Job List | GET /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/status?limit={limit}&offset={offset} | After the ID of an asynchronous job is returned, if the job ID at the service layer is lost and cannot be obtained through the API, a new API is provided to query all asynchronous jobs stored in the engine. The job ID, job status, and original request of each job are returned. |
| Parameter | Version | URL | Function |
|---|---|---|---|
| Filtered-query API | POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=filtered-query | Filter the k-hop process layer by layer, and list the k-hop vertices or edges that meet the filter criteria. | |
| Updating Specified Properties of Vertices and Edges by Importing a File | POST /v1.0/{project_id}/graphs/{graph_name}/action?action_id=import-properties | Update specified properties of vertices and edges by importing a file. |
Last Article: Management Plane API Overview
Next Article: Calling APIs
Did this article solve your problem?
Thank you for your score!Your feedback would help us improve the website.