Common Neighbors of Vertex Sets

Updated on 2025-03-13 GMT+08:00

View PDF

Function

This API is used to execute the Common Neighbors of Vertex Sets algorithm based on input parameters.

By selecting the common neighbors of two vertex sets, you can intuitively discover the objects associated with the two sets.

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 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
sources	Yes	String	Set of start vertex IDs in the standard CSV format. IDs are separated by commas (,), for example, ["Alice","Nana"]. The number of IDs cannot exceed 100,000.
targets	Yes	String	Set of end vertex IDs in the standard CSV format. IDs are separated by commas (,), for example, ["Mike","Amy"]. The number of IDs cannot exceed 100,000.
restricted	No	Boolean	Whether other constraints are involved. The value can be true or false. The default value is true. false: There is no additional constraint. The found common neighbors are the intersection of the neighborhoods corresponding to the source vertex set and target vertex set. true: There are additional constraints. The found common neighbors are not only the intersection of the neighborhoods corresponding to the source vertex set and target vertex set, but each vertex in the common neighbor set has at least two neighboring vertices in the source vertex set and target vertex set.

Response Parameters

Parameter	Type	Description
errorMessage	String	System prompt. If 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. If 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 the algorithm execution job. This parameter is left blank when 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 when the request fails.

Example Request

POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm 
 { 
  "algorithmName":"common_neighbors_of_vertex_sets", 
  "parameters":{ 
         "sources"="Alice,Nana",
         "targets"="Mike,Amy" 
  } 
 }

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": "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.