# 查询云服务器组列表 - ListServerGroups
#### 功能介绍
查询云服务器组列表。
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=ECS&api=ListServerGroups)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ecs/ecs_06_0000.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
 
| 授权项                               | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名                    | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| ecs:cloudServers:listServerGroups | list | -           | -   | ecs:cloudServers:list | -      |
   
#### URI
GET /v1/{project_id}/cloudservers/os-server-groups
参数说明请参见[表1]。
 表1路径参数 
| 参数         | 是否必选 | 描述                                                                                                                                                                                                                                                                                                                                                                             |
|:---|:---|:---|
| project_id | 是    | **参数解释：** 项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-ecs/ecs_01_0016.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
表2查询参数 
| 参数     | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|:---|
| limit  | 否    | Integer | **参数解释：** 查询返回server group数量限制。 **约束限制：** 最大值为1000。 **取值范围：** 1-1000 **默认取值：** 不涉及                                                     |
| marker | 否    | String  | **参数解释：** 以单页最后一条云服务器组id作为分页标记，从marker指定的server group的下一条数据开始查询。 **约束限制：** marker必须和limit配合使用，marker不能独立使用。 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
#### 请求消息
无
#### 响应消息
响应参数如[表3]所示。
 表3响应参数 
| 参数            | 参数类型             | 描述                                                                                                                                                                                           |
|:---|:---|:---|
| server_groups | Array of objects | **参数解释：** 云服务器组信息。更多信息请参见[表4]。 **取值范围：** 不涉及 |
| page_info     | Object           | **参数解释：** 当选择分页功能时返回当前页最后一个云服务器组的UUID信息。更多信息请参见[表5]。 **取值范围：** 不涉及    |
   
 表4server_groups参数信息 
| 参数       | 参数类型             | 描述                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|
| id       | String           | **参数解释：** 云服务器组UUID。 **取值范围：** 不涉及                                                                                                                                                         |
| name     | String           | **参数解释：** 云服务器组名称。 **取值范围：** 不涉及                                                                                                                                                       |
| members  | Array of strings | **参数解释：** 云服务器组中包含的云服务器列的ID列表。 **取值范围：** 不涉及                                                                                                                                             |
| metadata | Object           | **参数解释：** 云服务器组元数据。 **取值范围：** 不涉及                                                                                                                                                     |
| policies | Array of strings | **参数解释：** 与云服务器组关联的策略名称列表。 **取值范围：** - anti-affinity：此组中的云服务器必须安排到不同的主机。   |
   
 表5page_info数据结构说明 
| 参数          | 参数类型   | 描述                                                                                                                           |
|:---|:---|:---|
| next_marker | String | **参数解释：** 云服务器组的UUID。 **取值范围：** 不涉及 |
   
#### 请求示例
查询云服务器组列表。
```
GET https://{endpoint}/v1/{project_id}/cloudservers/os-server-groups
```
#### 响应示例
```
{
   "server_groups": [
      {
         "members": [],
         "metadata": {},
         "id": "318b44a7-f7a6-4c0b-8107-e8bd618b28dd",
         "policies": [
                     "anti-affinity"
                     ],
         "name": "SvrGrp-b9d6"
  },
  {
         "members": [],
         "metadata": {},
         "id": "b8f4cfc4-9a59-498c-9b52-643ee6515cd0",
         "policies": [
                     "anti-affinity"
                     ],
         "name": "SvrGrp-10a1"
  }
 ]
}
```
#### 返回值
请参考[通用请求返回值](https://support.huaweicloud.com/api-ecs/ecs_07_0001.html)。
#### 错误码
请参考[错误码](https://support.huaweicloud.com/api-ecs/ecs_07_0002.html)。