Database Edition
Database edition service plane APIs include vertex operations, edge operations, metadata operations, index operations, HyG dataset management, HyG algorithm, HyG job management, native algorithms, graph statistics, graph operations, job management, and Cypher operations.
API |
URL |
Function |
---|---|---|
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/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. |
API |
URL |
Function |
---|---|---|
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/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. |
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. |
|
GET /ges/v1.0/{project_id}/graphs/{graph_name}/schema?label={labelName} |
Query labels. |
|
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. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/ indices/action?action_id=batch-build |
Create indexes in batches. By doing so, the number of data scans is reduced and the overall time required is shorten. |
API |
URL |
Function |
---|---|---|
POST /ges/v1.0/{project_id}/hyg/{graph_name} |
Create a HyG graph. |
|
POST /ges/v1.0/{project_id}/hyg/{graph_name}/sync |
Synchronize graph database updates to the HyG computing engine. |
|
GET /ges/v1.0/{project_id}/hyg/{graph_name}/summary |
Query general information about a HyG graph, such as the number of vertices, number of edges, properties, and partitioning policies. |
|
DELETE /ges/v1.0/{project_id}/hyg/{graph_name} |
Delete a HyG graph. |
|
GET /ges/v1.0/{project_id}/hyg |
List HyG graphs. |
|
POST /ges/v1.0/{project_id}/hyg/{graph_name}/import-graph |
Import HyG graph data. |
API |
URL |
Function |
---|---|---|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/hyg/algorithm |
Run the HyG algorithm. |
|
POST /ges/v1.0/{project_id}/hyg/{graph_name}/dsl |
Provide flexible DSLs to help users design and run algorithms at low costs. |
API |
URL |
Function |
---|---|---|
POST /ges/v1.0/{project_id}/hyg/{graph_name}/jobs/{job_id}/export-result |
Dump the execution results of the algorithm (jobId) to OBS. |
|
DELETE /ges/v1.0/{project_id}/hyg/{graph_name}/jobs/{job_id} |
Cancel a submitted HyG job. (Currently, only jobs in a queue can be canceled.) |
API |
URL |
Function |
---|---|---|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-algorithm |
Run native algorithms. |
API |
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. |
API |
URL |
Function |
---|---|---|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id= import-graph |
Import graph data. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=clear-graph |
Clear graph data. |
|
POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=export-graph |
Export graph data. |
|
POST /ges/v1.0/{project_id}/graphs |
Create a graph. |
|
DELETE /ges/v1.0/{project_id}/graphs/{graph_name} |
Delete a graph. |
|
GET /ges/v1.0/{project_id}/graphs |
List graphs. |
API |
URL |
Function |
---|---|---|
GET/ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}/status?offset=offset&limit=limit |
Query the job status. |
|
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-cypher-query |
Run Cypher statements to query data in GES and obtain results. |
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