Incrementally Importing Data to a Graph
Function
This API is used to import data to graphs incrementally.
![](https://support.huaweicloud.com/eu/api-ges/public_sys-resources/note_3.0-en-us.png)
To prevent failures in restoring the imported graph data during system restarting, do not delete the data stored on OBS when the graph is in use.
URI
POST /v2/{project_id}/graphs/{graph_id}/import-graph
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
graph_id |
Yes |
String |
Graph ID |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It is used to obtain the permission to call APIs. For details about how to obtain the token, see Authentication. The value of X-Subject-Token in the response header is the token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
edgeset_path |
No |
String |
Edge file directory or name |
edgeset_format |
No |
String |
Format of the edge data set. Currently, only the CSV format is supported. The CSV format is used by default. |
vertexset_path |
No |
String |
Vertex file directory or name |
vertexset_format |
No |
String |
Format of the vertex data set. Currently, only the CSV format is supported. The CSV format is used by default. |
schema_path |
No |
String |
Path for storing the metadata file of the new data. |
log_dir |
No |
String |
Directory for storing logs of imported graphs. This directory stores the data that fails to be imported during graph creation and detailed error causes. |
parallel_edge |
No |
parallel_edge object |
How to process repetitive edges. |
delimiter |
No |
String |
Field separator in a CSV file. The default value is comma (,). The default element separator in a field of the list/set type is semicolon (;). |
trim_quote |
No |
String |
Field quote character in a CSV file. The default value is double quotation marks ("). They are used to enclose a field if the field contains separators or line breaks. |
offline |
No |
Boolean |
Whether offline import is selected. The value is true or false, and the default value is false.
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
action |
No |
String |
Processing mode of repetitive edges. The value can be allow, ignore, or override. The default value is allow.
|
ignore_label |
No |
Boolean |
Whether to ignore labels on repetitive edges. The value is true or false, and the default value is true.
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
ID of an asynchronous job |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
System prompt code.
|
error_msg |
String |
System prompt code.
|
Example Request
Incrementally import graph data. The edge file directory is testbucket/demo_movie/edges/ and the edge data set is in CSV format. The vertex file directory is testbucket/demo_movie/vertices/ and the vertex data set is in CSV format.
POST http://Endpoint/v2/{project_id}/graphs/{graph_id}/import-graph { "edgeset_path" : "testbucket/demo_movie/edges/", "edgeset_format" : "csv", "vertexset_path" : "testbucket/demo_movie/vertices/", "vertexset_format" : "csv", "schema_path" : "testbucket/demo_movie/incremental_data_schema.xml", "log_dir" : "testbucket/importlogdir", "parallel_edge" : { "action" : "override", "ignore_label" : true }, "delimiter" : ",", "trim_quote" : "\"", "offline" : false }
Example Response
Status code: 200
Example response for a successful request
{ "job_id" : "b4f2e9a0-0439-4edd-a3ad-199bb523b613" }
Status code: 400
Example response for a failed request
{ "error_msg" : "parameter format error", "error_code" : "GES.8013" }
Status Codes
Return Value |
Description |
---|---|
400 Bad Request |
Request error. |
401 Unauthorized |
Authorization failed. |
403 Forbidden |
No operation permissions. |
404 Not Found |
No resources found. |
500 Internal Server Error |
Internal server error. |
503 Service Unavailable |
Service unavailable. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.