Creating a HyG Graph

This API is used to create a HyG graph.

Computing of graphs of the database edition relies on the HyG engine. Before executing an algorithm, you need to create a HyG graph and synchronize data from the graph database to the HyG engine.
To apply for access to the HyG component, submit a service ticket as it is currently only available through a whitelist.

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

**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

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
policy	No	String	Graph partitioning policy. Currently, the oec policy is supported. The default policy is oec.
inEdge	No	Boolean	Whether the graph contains incoming edges. The default value is false. If this parameter is set to true, the data synchronization performance will be affected. For some algorithms, such as shortest_path, sssp, and k_hop, if the incoming edges are not contained, the algorithm performance may deteriorate or an error may be reported. For details, see the parameter description of the corresponding algorithm.

**Table 3** 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.
result	String	Execution results If the execution is successful, the value is success. If the execution fails, the value is failed.

To create a HyG graph, set the partitioning policy to oec and configure the graph to contain incoming edges.

POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}
{
    "policy": "oec",
    "inEdge": true
}

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

Status code: 200

Example response for a successful request

Http Status Code: 200
{
   "result": "success"
 }

Status code: 400

Example response for a failed request

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