Synchronizing HyG Graph Data

Function

This API is used to synchronize graph database updates to the HyG computing engine.

URI

POST /ges/v1.0/{project_id}/hyg/{graph_name}/sync

**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
vertex	No	JSON	Vertex property list. If the list is empty, vertex properties will not be synchronized. For details about the parameters, see Table 3. During the initial data synchronization, this parameter will be applied. For subsequent synchronizations, this parameter will default to the value specified during the first synchronization.
edge	No	JSON	Edge property list. If the list is empty, edge properties will not be synchronized. For details about the parameters, see Table 3. During the initial data synchronization, this parameter will be applied. For subsequent synchronizations, this parameter will default to the value specified during the first synchronization.

**Table 3** 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.

Response Parameters

**Table 4** Parameter description
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 NOTE: You can view the job execution status and obtain the return result by querying the job ID. For details, see Job Management APIs.

Suspended edges in a graph database (edges that do not have either a source or a target node) are not synchronized to the HyG engine.

Example Request

Synchronize the update information of the graph database to the HyG computing engine, with an empty vertex property list, an edge property list with the property name Rating, and a label name of rate.

POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/sync
{
    "vertex": [],
    "edge": [
        {
            "property": [
                "Rating"
            ],
            "label": "rate"
        }
    ]
}

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": "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232"
}

Status code: 400

Example response for a failed request

Http Status Code: 400
{
    "errorCode": "GES.8011",
    "errorMessage": "graph : movie2 is not exist"
}

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.