Memory Edition
Memory edition service plane APIs cover vertex operations, edge operations, metadata operations, index operations, Gremlin operations, algorithms, paths, graph statistics, graph and subgraph operations, job management, and Cypher operations.
API |
URL |
Function |
---|---|---|
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'. |
|
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. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices |
Add a vertex. |
|
DELETE/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id} |
Delete a vertex. |
|
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. |
|
POST/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-query |
Query vertex details in batches. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-add |
Add 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. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/properties/action?action_id={actionId} |
Update vertex properties in batches. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}/labels |
Add a vertex label. |
|
DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}/labels/{label_name} |
Delete a vertex label. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=export |
Export the vertex set that meets the filter criteria. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=delete |
Delete the vertex set that meets the filter criteria. |
API |
URL |
Function |
---|---|---|
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. |
|
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. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges |
Add an edge. |
|
DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/edges?source={sourceVertex}&target={targetVertex}&index={index} |
Delete an edge. |
|
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. |
|
POST/ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-query |
Query edge details in batches. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-add |
Add 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. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/properties/action?action_id={actionId} |
Update edge properties in batches. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=export |
Export the edge set that meets the filter criteria. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=delete |
Delete the edge set that meets the filter criteria. |
API |
URL |
Function |
---|---|---|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels |
Add a label. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/{label_name}/properties |
Update a label. |
|
GET /ges/v1.0/{project_id}/graphs/{graph_name}/schema |
Query metadata details. |
|
DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/{labelName} |
Delete a label as well as the vertices and edges associated with the label. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/action?action_id=batch-add |
Add labels in batches. |
|
GET /ges/v1.0/{project_id}/graphs/{graph_name}/schema/structure?detail={details} |
Query a generated schema (obtained from OBS). |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema/structure/build |
Generate a schema where labels are represented with vertices and the relationship between the labels are represented with edges, and store the schema in an OBS bucket. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema/data-assets |
Generate data assets. |
|
GET /ges/v1.0/{project_id}/graphs/{graph_name}/schema/data-assets |
Obtain data assets. |
API |
URL |
Function |
---|---|---|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/indices |
Create an index. |
|
DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/indices/{indexName} |
Delete an index. |
|
GET /ges/v1.0/{project_id}/graphs/{graph_name}/indices |
Query indexes. |
API |
URL |
Function |
---|---|---|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-gremlin-query |
Execute Gremlin queries. |
Operation |
URL |
Function |
---|---|---|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-algorithm |
Run algorithms. |
API |
URL |
Function |
---|---|---|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/dynamicgraphs/action?action_id=execute-analysis |
The community evolution algorithm generates a temporal graph that shows structure changes of a community over time. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/dynamicgraphs/action?action_id=execute-analysis |
This algorithm searches for associated vertices based on temporal message passing and temporal BFS algorithms, and outputs the visit time of each vertex and the distance from the vertex to the source start vertex. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/dynamicgraphs/action?action_id=execute-analysis |
Execute the temporal paths algorithm based on input parameters. Only one temporal path that meets the conditions is returned between two vertices. |
Parameter |
URL |
Function |
---|---|---|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/paths/action?action_id=query-detail |
Query the path details. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=query-tree |
After you input a vertex, a tree starting from the vertex is output, including nodes and edges in the tree, and information about reachable paths. Parameters can be the direction (out, in, and out and in), maximum number of hops, and edge properties to be filtered. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=repeat-query |
Cyclically perform traversal query based on certain exit conditions. |
Operation |
URL |
Function |
---|---|---|
GET /ges/v1.0/{project_id}/graphs/{graph_name}/summary |
Query general information about a graph. |
|
GET /ges/v1.0/{project_id}/graphs/{graph_name}/version |
Query the graph version. |
Operation |
URL |
Function |
---|---|---|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id= import-graph |
Import data. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=export-graph |
Export data. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=clear-graph |
Clear data. |
Operation |
URL |
Function |
---|---|---|
POST/ges/v1.0/{project_id}/graphs/{graph_name}/subgraphs/action?action_id=query |
Query the subgraphs that are created by the specified vertices and the edges connecting them. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/subgraphs/action?action_id=execute-algorithm |
Adjust the subgraph creation type based on the input and execute an algorithm on the generated subgraph. |
Operation |
URL |
Function |
---|---|---|
GET/ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}/status?offset=offset&limit=limit |
Query job status. |
|
DELETE https://Endpoint/ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id} |
Cancel a job. |
|
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. |
|
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. |
API |
URL |
Function |
---|---|---|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-operation |
Query the job status. |
API |
URL |
Function |
---|---|---|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/rbac/action?action_id=grant |
Grant fine-grained permissions. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/rbac/action?action_id=revoke |
Revoke permissions. |
|
GET /ges/v1.0/{project_id}/graphs/{graph_name}/rbac |
Query all label and property permissions of the current user. |
API |
URL |
Function |
---|---|---|
GET /ges/v1.0/{project_id}/graphs/{graph_name}/om/metrics?real_time=&with_performance_metrics= |
View monitoring metrics, including node metrics and graph instance performance monitoring metrics. |
|
GET/ges/v1.0/{project_id}/graphs/{graph_name}/om/real-time-queries?summary= |
View the real-time requests on the current primary node. |
Operation |
URL |
Function |
---|---|---|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-cypher-query |
Run Cypher statements to query data in GES and obtain results. |
|
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. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=path-query |
This is a new version of the Filtered Query API. This API supports both Filtered Query and Repeat Query functions. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=algorithm-query |
Provide flexible and controllable DSLs to help users design and run algorithms at low costs. |
|
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. |
POST /v1.0/{project_id}/graphs/{graph_name}/action?action_id=delete-by-file |
Delete vertices and edges by reading the files. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot