# 点集共同邻居(common_neighbors_of_vertex_sets)
#### 功能介绍
根据输入参数，执行点集共同邻居算法。
点集共同邻居（Common Neighbors of Vertex Sets）可以得到两个点集合（群体集合）所共有的邻居（即两个群体临域的交集），直观的发现与两个群体共同联系的对象，
#### 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 
|     参数     | 是否必选 |   类型    |                                                                                                                                                                         说明                                                                                                                                                                          |
|---|---|---|---|
| sources    | 是    | String  | 起点ID集合，标准csv格式，ID之间以英文逗号分隔，例如："Alice,Nana"，个数不大于100000。                                                                                                                                                                                                                                                                                             |
| targets    | 是    | String  | 终点ID集合标准csv格式，ID之间以英文逗号分隔，例如："Mike,Amy"，个数不大于100000。                                                                                                                                                                                                                                                                                                |
| restricted | 否    | Boolean | 是否带其他约束，取值为true或false，默认取值为true。 - false：不带额外约束，即找到的共同邻居为起点集和终点集对应邻域的交集。  - true，带额外约束，这里指找到的共同邻居不仅是起点集和终点集邻域的交集，同时共同邻居集合中的每个点都至少有2个及以上邻居节点在起点集和终点集中。   |
   
#### 响应参数
|        参数        |   类型    |                                                                                                                                            说明                                                                                                                                            |
|---|---|---|
| errorMessage     | String  | 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。                                                                                                                                                                                                                                                      |
| errorCode        | String  | 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。                                                                                                                                                                                                                                                       |
| jobId            | String  | **参数解释**： 执行算法任务ID。请求失败时，该字段为空。 说明： 可以利用返回的jobId查看任务执行状态、获取算法返回结果，详情参考[查询Job状态(1.0.0)](https://support.huaweicloud.com/api-ges/ges_03_0037.html)。 **取值范围**： 不涉及。 |
| vertices         | List    | 共同邻居，格式： \[vertexId,...\] 其中, vertexId：string类型                                                                                                                                                  |
| common_neighbors | Integer | 公共邻居节点个数。                                                                                                                                                                                                                                                                                |
   
#### 请求示例
```
POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm 
{
  "algorithmName":"common_neighbors_of_vertex_sets",
  "parameters":{
  "sources":"Alice,Nana",
  "targets":"Mike,Amy"
   }
}
```
![](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)。