# louvain算法（louvain）
#### 功能介绍
根据输入参数，执行Louvain算法。
Louvain算法是基于模块度的社区发现算法，该算法在效率和效果上都表现较好，并且能够发现层次性的社区结构，其优化目标是最大化整个社区网络的模块度。
#### URI
```
POST /ges/v1.0/{project_id}/hyg/{graph_name}/algorithm
```
表1路径参数 
| 参数         | 是否必选 | 类型     | 说明                                                                                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释：** 项目编号。获取方法，请参见[获取项目ID](https://support.huaweicloud.com/api-ges/ges_03_0111.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母和数字组成，且长度为\[1-64\]个字符。 **默认取值：** 不涉及。 |
| graph_name | 是    | String | **参数解释：** 图名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                                          |
   
#### 请求参数
表2请求Body参数 
|      参数       | 是否必选 |                          类型                           |  说明   |
|---|---|---|---|
| algorithmName | 是    | String                                                | 算法名字。 |
| parameters    | 否    | [parameters] Object | 算法参数。 |
   
 表3parameters 
|       参数       | 是否必选 |                     类型                     |                                                                                                                                   说明                                                                                                                                    |
|---|---|---|---|
| convergence    | 否    | Double                                     | 收敛精度，取值范围为(0,1)，默认值为0.00001。                                                                                                                                                                                                                                            |
| max_iterations | 否    | Integer                                    | 最大迭代次数。API调用限制为\[1,2147483647\]，前端调用限制为\[1,2000\]，默认值为100。                                                                                                                                                                                                              |
| weight         | 否    | String  | 边上权重，取值为空或字符串， 当图中的边没有配置该属性时，算法会报错。 - 空：边上的权重、距离默认为"1"。  - 字符串：对应的边上的属性将作为权重。   |
   
#### 响应参数
|      参数       |   类型    |                                                                                                                                            说明                                                                                                                                            |
|---|---|---|
| errorMessage  | String  | 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。                                                                                                                                                                                                                                                      |
| errorCode     | String  | 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。                                                                                                                                                                                                                                                       |
| jobId         | String  | **参数解释**： 执行算法任务ID。请求失败时，该字段为空。 说明： 可以利用返回的jobId查看任务执行状态、获取算法返回结果，详情参考[查询Job状态(1.0.0)](https://support.huaweicloud.com/api-ges/ges_03_0037.html)。 **取值范围**： 不涉及。 |
| modularity    | Double  | 模块度。                                                                                                                                                                                                                                                                                     |
| community_num | Integer | 社团数量。                                                                                                                                                                                                                                                                                    |
| community     | List    | 各节点对应的社团(community)，格式： \[{vertexId:communityId},...\] 其中, vertexId: string类型。 communityId: string类型。                                                          |
   
#### 请求示例
```
POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm  
{ 
 "algorithmName":"louvain", 
 "parameters":{ 
        "convergence":0.00001, 
        "max_iterations":100
 } 
}
```
![](https://support.huaweicloud.com/api-ges/public_sys-resources/note_3.0-zh-cn.png)
SERVER_URL：图的访问地址，取值请参考[业务面API使用限制](https://support.huaweicloud.com/api-ges/ges_03_0139.html)。
#### 响应示例
**状态码： 200**
成功响应示例
```
Http Status Code: 200
{  
"jobId": "4448c9fb-0b16-4a78-8d89-2a137c53454a001679122"
}
```
**状态码： 400**
失败响应示例
```
Http Status Code: 400
{
    "errorMessage": "Parameter error!",
    "errorCode": "GES.8005"
}
```
#### 状态码
| 返回值                       | 说明     |
|:---|:---|
| 400 Bad Request           | 请求错误   |
| 401 Unauthorized          | 鉴权失败   |
| 403 Forbidden             | 没有操作权限 |
| 404 Not Found             | 找不到资源  |
| 500 Internal Server Error | 服务内部错误 |
| 503 Service Unavailable   | 服务不可用  |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-ges/ges_03_0110.html)。