Cluster Coefficient

Function

This API is used to run the Cluster Coefficient algorithm based on input parameters.

This algorithm is used to calculate the aggregation degree of vertices in a graph.

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
statistics	No	Boolean	Whether only the overall statistical results are output. The options are true and false. The default value is true. true: Only the total average clustering coefficient is output. false: The clustering coefficient corresponding to each vertex is additionally output.
directed	No	Boolean	Whether a graph is considered as a directed graph for calculation. The value can be true or false. The default value is false. true: directed graph false: undirected graph

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":"cluster_coefficient",
    "parameters": {
        "statistics":"false",
        "directed":"false"
    }
}

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"
}

Query result

Example Request

GET http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{jobId}/status?limit=limit

Query result response

**Table 4** response_data parameter description
Parameter	Type	Description
cluster_coefficient	Double	Average clustering coefficient
vertex_cluster_coefficient	List	Clustering coefficient of each vertex. The format is as follows: [{vertexId : vertexClusterCoefficient},...], where vertexId: string type vertexClusterCoefficient: double type Vertex clustering coefficients are sorted in descending order based on their values. If two coefficients have the same value, they are sorted by vertex ID.

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.