# 获取实例组信息列表
#### 功能介绍
获取DDM实例的组信息详情。
#### 接口约束
无
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DDM&api=ListEngines)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### URI
- URL格式 GET /v3/{project_id}/instances/{instance_id}/groups?offset={offset}\&limit={limit}
  
- 参数说明
  表1路径参数 
  | 参数          | 是否必选 | 参数类型   | 描述                                                                                                                                                        |
  |:---|:---|:---|:---|
  | project_id  | 是    | String | 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-ddm/ddm_api_01_0063.html)。 |
  | instance_id | 是    | String | DDM实例ID。                                                                                                                                                  |
     
  表2Query参数 
  | 参数     | 是否必选 | 参数类型    | 描述                                                                                                                         |
  |:---|:---|:---|:---|
  | offset | 否    | Integer | 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0。 取值必须为数字，且不能为负数。 |
  | limit  | 否    | Integer | 查询个数上限值。 取值范围：1\~128。 不传该参数时，默认值为10。                      |
     
  
 
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                     |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | 用户Token。 通过调用IAM服务的"获取用户Token"接口来获取。 |
   
#### 请求示例
```
GET https://{endpoint}/v3/{project_id}/instances/{instance_id}/groups?offset=null&limit=null
```
#### 响应参数
- 正常响应参数说明
  表4响应Body参数 
  | 参数          | 参数类型                                                               | 描述        |
  |:---|:---|:---|
  | total_count | Integer                                                            | 总条数。      |
  | group_list  | Array of [表5] objects | 实例的组信息列表。 |
     
   表5GroupInfo 
  | 参数               | 参数类型                                                             | 描述                                                                                                                                                                                                                                                                                          |
  |:---|:---|:---|
  | id               | String                                                           | 组ID。                                                                                                                                                                                                                                                                                        |
  | name             | String                                                           | 组名称。                                                                                                                                                                                                                                                                                        |
  | role             | String                                                           | 组角色类型，分为读写组和只读组。 返回值： - **rw**：读写组  - **r**：只读组   |
  | endpoint         | String                                                           | 组的连接地址。如果没有开启负载均衡，则返回的是组内节点的连接地址串。                                                                                                                                                                                                                                                          |
  | ipv6_endpoint    | String                                                           | 组IPv6的连接地址。                                                                                                                                                                                                                                                                                 |
  | is_load_balance  | Boolean                                                          | 是否开启负载均衡。                                                                                                                                                                                                                                                                                   |
  | is_default_group | Boolean                                                          | 是否为默认组。                                                                                                                                                                                                                                                                                     |
  | cpu_num_per_node | Integer                                                          | 单节点CPU的核数。                                                                                                                                                                                                                                                                                  |
  | mem_num_per_node | Integer                                                          | 单节点的内存大小，单位为GB。                                                                                                                                                                                                                                                                             |
  | architecture     | String                                                           | CPU架构。 返回值： - **X86**  - **ARM**             |
  | node_list        | Array of [表6] objects | 节点信息列表。                                                                                                                                                                                                                                                                                     |
     
   表6GroupNodeInfo 
  | 参数   | 参数类型   | 描述        |
  |:---|:---|:---|
  | id   | String | 节点ID。     |
  | name | String | 节点名称。     |
  | az   | String | 节点所在的可用区。 |
     
  
 
#### 响应示例
- 正常响应示例
  ```
  { 
      "group_list":[ 
          { 
              "id":"****gr09", 
              "name":"group-default", 
              "role":"rw", 
              "endpoint":"**.**.**.**:5066", 
              "is_load_balance":true, 
              "is_default_group":false, 
              "architecture":"X86", 
              "cpu_num_per_node":4, 
              "mem_num_per_node":8, 
              "node_list":[ 
                  { 
                      "id":"****no09", 
                      "name":"node_01", 
                      "az":"some_az" 
                  } 
              ] 
          } 
      ], 
      "total_count":1 
  }
  ```
  
- 异常响应 请参见[异常请求结果](https://support.huaweicloud.com/api-ddm/ddm_api_01_0059.html)。
  
 
#### 状态码
- 正常 200
  
- 异常 请参见[状态码](https://support.huaweicloud.com/api-ddm/ddm_api_01_0060.html)。
  
 
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-ddm/ddm_api_01_0061.html)。