Circle Detection with a Single Vertex

Function

This API is used to execute the Circle Detection with a Single Vertex algorithm based on input parameters.

This Circle Detection with a Single Vertex algorithm detects loops in a graph. Vertices on looped paths reflect the importance of the vertices.

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
source	Yes	String	ID of the vertex
min_circle_length	No	Integer	Minimum circle length. The value range is [3, 15]. The default value is 3.
max_circle_length	No	Integer	Maximum circle length (min_circle_length <= max_circle_length). The value range is [3, 15]. The default value is 10.
limit_circle_number	No	Integer	Maximum number of circles you want to search for. The value range is [1, 100000]. The default value is 100.

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":"single_vertex_circles_detection", 
  "parameters":{ 
         "source":66, 
         "min_circle_length":3, 
        "max_circle_length":7, 
        "limit_circle_number":10000
  } 
 }

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.