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
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
Parameter |
Mandatory |
Type |
Description |
algorithmName |
Yes |
String |
Algorithm name |
parameters |
No |
parameters Object |
Algorithm 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.
|
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.
|
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). |
cluster_coefficient |
Double |
Clustering coefficient |
vertex_cluster_coefficient |
List |
Clustering coefficient of each vertex. The format is: [{vertexId: cluster_coefficient },...] where, vertexId is of the string type. cluster_coefficient is of the double type. |
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" }
Status code: 400
Example response for a failed request
Http Status Code: 400 { "errorMessage": "Parameter error!", "errorCode": "GES.8005" }
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. |
Error Codes
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot