K-Hop

Function

This API is used to run the K-Hop algorithm based on input parameters.

This algorithm is used to search all nodes in the k layer that are associated with the source node through Breadth-First Search (BFS). The found sub-graph is the source node's ego-net. This algorithm returns the number of nodes in the ego-net.

URI

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

**Table 1** URI parameters
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_name	Yes	String	Graph name

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
algorithmName	Yes	String	Algorithm name
parameters	Yes	parameters Object	Algorithm parameters

**Table 3** parameters
Parameter	Mandatory	Type	Description
k	Yes	Integer	Number of hops. The value ranges from 1 to 100.
source	Yes	String	ID of the start node
mode	No	String	Search direction. Possible values are: OUT: Hop from the outgoing edges (default value) IN: Hop from the incoming edges. ALL: Hop along both incoming and outgoing edges NOTE: When the dataset does not contain incoming edges, if this parameter is set to OUT and an algorithm that does not depend on incoming edges is selected to calculate the output, the performance deteriorates. If this parameter is set to IN or ALL, an error is reported.
switch	No	Integer	When the number of activated edges reaches the total number of edges/switch value, the pull/push mode is switched. The value range is [1, 2000]. The default value is 40.

Response Parameters

Parameter	Type	Description
errorMessage	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.
errorCode	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
jobId	String	ID of the algorithm execution job. This parameter is left blank if the request fails. NOTE: You can use the returned job ID to view the task execution status and obtain the algorithm return result. For details, see Querying Job Status on the Service Plane (1.0.0).
jobType	Integer	Job type. This parameter is left blank if the request fails.

Example Request

POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm 
{
 "algorithmName":"k_hop",
 "parameters":{
        "k":3,
        "source":66,
        "mode":"ALL" 
 }
}

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": "4448c9fb-0b16-4a78-8d89-2a137c53454a001679122",
"jobType": 1
}

Status code: 400

Example response for a failed request

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

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.