louvain算法（louvain）
功能介绍
根据输入参数，执行Louvain算法。
Louvain算法是基于模块度的社区发现算法，该算法在效率和效果上都表现较好，并且能够发现层次性的社区结构，其优化目标是最大化整个社区网络的模块度。
URI
POST /ges/v1.0/{project_id}/hyg/{graph_name}/algorithm
参数 |
是否必选 |
类型 |
说明 |
|---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID。 |
graph_name |
是 |
String |
图名称。 |
请求参数
参数 |
是否必选 |
类型 |
说明 |
algorithmName |
是 |
String |
算法名字。 |
parameters |
是 |
parameters Object |
算法参数。 |
参数 |
是否必选 |
类型 |
说明 |
convergence |
否 |
Double |
收敛精度，取值范围为(0,1)，默认值为0.00001。 |
max_iterations |
否 |
Integer |
最大迭代次数。API调用限制为[1,2147483647]，前端调用限制为[1,2000]，默认值为100。 |
weight |
否 |
String |
边上权重，取值为空或字符串， 当图中的边没有配置该属性时，算法会报错。
|
OD_pairs和seeds参数二选一，当OD_pairs和seeds同时输入时，以OD_pair为准，忽略seeds。
响应参数
参数 |
类型 |
说明 |
errorMessage |
String |
系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。 |
errorCode |
String |
系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。 |
jobId |
String |
执行算法任务ID。请求失败时，字段为空。
说明：
可以利用返回的jobId查看任务执行状态、获取算法返回结果，详情参考查询Job状态(1.0.0)。 |
jobType |
Integer |
任务类型。请求失败时，字段为空。 |
请求示例
POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm
{
"algorithmName":"louvain",
"parameters":{
"convergence":0.00001,
"max_iterations":100
}
}
响应示例
状态码： 200
成功响应示例
Http Status Code: 200
{
"jobId": "4448c9fb-0b16-4a78-8d89-2a137c53454a001679122",
"jobType": 1
}
状态码： 400
失败响应示例
Http Status Code: 400
{
"errorMessage":"graph [demo] is not found",
"errorCode":"GES.8402"
}
状态码
返回值 |
说明 |
|---|---|
400 Bad Request |
请求错误 |
401 Unauthorized |
鉴权失败 |
403 Forbidden |
没有操作权限 |
404 Not Found |
找不到资源 |
500 Internal Server Error |
服务内部错误 |
503 Service Unavailable |
服务不可用 |
错误码
请参见错误码。
