On this page

Show all

Help Center/ Graph Engine Service/ API Reference/ Service Plane APIs/ Database Edition/ HyG Graph Management APIs/ Importing an HyG Graph

Importing an HyG Graph

Updated on 2024-05-20 GMT+08:00

View PDF

Function

This API is used to import HyG graph data.

URI

POST /ges/v1.0/{project_id}/hyg/{graph_name}/import-graph

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For how to obtain the project ID, see Obtaining a Project ID.
graph_name	Yes	String	Graph name

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
edgesetPath	Yes	String	Edge file directory or edge file name. CSV and TXT files can be imported.
vertexsetPath	Yes	String	Vertex file directory or vertex file name. CSV and TXT files can be imported.
schemaPath	Yes	String	OBS path of the metadata file of the new data
logDir	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.
delimiter	No	Character	Field separator in a CSV file. The default value is comma (,).
trimQuote	No	Character	Field quote character in a CSV file. The default value is double quotation marks ("). It is used to enclose a field if the field contains separators or line breaks.
obsParameters	Yes	Object	OBS parameters. For details about the parameters, see Table 3.
vertex	No	Object	List of vertex properties. The specified properties must belong to the schema file. If the list is empty, vertex properties will not be imported. For details about the parameters, see Table 4.
edge	No	Object	List of edge properties. The specified properties must belong to the schema file. If the list is empty, edge properties will not be imported. For details about the parameters, see Table 4.

**Table 3** obsParameters parameter description
Parameter	Mandatory	Type	Description
accessKey	Yes	String	User AK
secretKey	Yes	String	User SK

**Table 4** vertex and edge parameters
Parameter	Mandatory	Type	Description
label	Yes	String	Label name
property	Yes	Array of strings	Property name. The property must belong to the label. Supported property types include string, bool, int, long, double, and float.

Response Parameters

**Table 5** Response body parameters
Parameter	Type	Description
errorMessage	String	System prompt If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error message.
errorCode	String	System prompt code If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error code.
jobId	String	ID of an asynchronous job You can view the job execution status and obtain the return result by querying the job ID. For details, see Job Management APIs.

Example Request

Import a graph. The edge file directory is testbucket/demo_movie/edges/ and the edge data set format is CSV; the vertex file directory is testbucket/demo_movie/vertices/ and the vertex data set format is CSV; the OBS path of the metadata file of the new data is testbucket/demo_movie/schema.xml and the log storage directory is testbucket/importlogdir.

POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/import-graph
{
  "edgesetPath": "testbucket/demo_movie/edges/",
  "vertexsetPath": "testbucket/demo_movie/vertices/",
  "schemaPath": "testbucket/demo_movie/schema.xml",
  "logDir": "testbucket/importlogdir",
  "delimiter": ",",
  "trimQuote": "\"",
  "obsParameters": {
    "accessKey": "xxxxxx",
    "secretKey": "xxxxxx"
  },
  "vertex": [
        {
            "property": [
                "title",
                "movieid"
            ],
            "label": "movie"
        }
    ],
    "edge": [
        {
            "property": [
                "Rating",
                "Datetime"
            ],
            "label": "rate"
        }
    ]
}

NOTE:

SERVER_URL: Address for accessing a graph. For details about its value, see Using Service Plane APIs.

Example Response

Status code: 200

Example response for a successful request

Http Status Code: 200
{
  "jobId": "b4f2e9a0-0439-4edd-a3ad-199bb523b613"
}

Status code: 400

Example response for a failed request

Http Status Code: 400
{
   "errorCode": "GES.8013",
   "errorMessage": "graph [movie2] is not found"
}

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 for Service Plane APIs.

Parent topic: HyG Graph Management APIs

Previous topic: Listing HyG Graphs

Next topic: HyG Algorithm APIs

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot