# 查询租户服务器组基础信息列表 - ListTenantServerGroups
#### 功能介绍
查询租户服务器组基础信息列表(用于创建应用组时绑定服务器组)。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/WorkspaceApp/doc?api=ListTenantServerGroups)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                              | 访问级别 | 资源类型（\*为必须）    | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | workspace:serverGroup:listDetail | List | serverGroup \* | -   | -  | -      |
     
  
 
#### URI
GET /v1/{project_id}/app-server-groups/actions/list
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述      |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目唯一标识。 |
   
表2Query参数 
| 参数                        | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|:---|:---|:---|:---|
| offset                    | 否    | Integer | 查询的偏移量，默认值0。                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| limit                     | 否    | Integer | 查询的数量，值区间\[1-100\]，默认值10。                                                                                                                                                                                                                                                                                                                                                                                                                                |
| sever_group_name          | 否    | String  | 服务器组名称。                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| app_type                  | 否    | String  | 应用组类型： - *SESSION_DESKTOP_APP* - 会话桌面app   - *COMMON_APP* - 普通app    |
| is_secondary_server_group | 否    | String  | 是否为备服务器组，不传默认查所有： true : 是备服务器组。 false: 主服务器组，默认。                                                                                                                                                                                                                                                                                                                    |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                  |
|:---|:---|:---|:---|
| X-Auth-Token | 否    | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数    | 参数类型                                                                                | 描述      |
|:---|:---|:---|
| count | Integer                                                                             | 总数。     |
| items | Array of [ServerGroupDto] objects | 服务器组列表。 |
   
 表5ServerGroupDto 
| 参数                         | 参数类型             | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|
| id                         | String           | 服务器组的唯一标识。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| name                       | String           | 服务器组名称。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| description                | String           | 服务器组描述。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| image_id                   | String           | 服务器组关联的镜像ID，用于创建对应组下的云服务器。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| os_type                    | String           | 系统类型，当前仅支持Windows。 - *Linux* -   - *Windows* -   - *Other* -                                                                                                                                                                                                                                                                                                                                                                      |
| product_id                 | String           | 产品id。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| subnet_id                  | String           | 网卡对应的子网ID。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| system_disk_type           | String           | 磁盘类型，获取可用磁盘类型详见接口磁盘管理ListVolumeType。 - *ESSD* - 极速型SSD   - *SSD* - 超高IO   - *GPSSD* - 通用型SSD   - *SAS* - 高IO   - *SATA* - 普通IO    |
| system_disk_size           | Integer          | 磁盘容量，单位GB。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| is_vdi                     | Boolean          | 是否为vdi单会话模式。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| extra_session_type         | String           | 付费会话类型： - *GPU* - GPU规格会话。   - *CPU* - 普通CPU规格会话。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| extra_session_size         | Integer          | 付费会话个数。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| app_type                   | String           | 服务器组应用类型： - *SESSION_DESKTOP_APP* - 会话桌面app   - *COMMON_APP* - 普通app                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| create_time                | String           | 服务器组创建时间。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| update_time                | String           | 服务器组更新时间。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| storage_mount_policy       | String           | 用户访问APS的应用时，对应NAS存储目录在APS上的挂载策略。 - *USER* - 仅挂载个人目录。   - *SHARE* - 仅挂载共享目录。   - *ANY* - 挂载目录不做限制(个人和共享NAS存储目录都会自动挂载)。                                                                                                                                                                                                                                                                                                             |
| enterprise_project_id      | String           | 企业项目ID(0表示默认企业项目Id)。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| primary_server_group_ids   | Array of strings | 主服务器组id列表。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| secondary_server_group_ids | Array of strings | 备服务器组id列表。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| server_group_status        | Boolean          | 服务器是否处于启用状态，true表示处于启用状态 false表示处于禁用状态。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| site_type                  | String           | 站点类型 - CENTER/IES。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| site_id                    | String           | 站点id。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| app_group_count            | Integer          | 关联应用组的总数量。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
   
**状态码：400**
表6响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：401**
表7响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：403**
表8响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：404**
表9响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：405**
表10响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：500**
表11响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：503**
表12响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
#### 请求示例
无
#### 响应示例
**状态码：200**
成功响应。
```
{
  "count" : 0,
  "items" : [ {
    "id" : "1",
    "name" : "流程开发应用服务器组",
    "description" : "XXX公司 软件开发应用服务器组。",
    "image_id" : "a6ea73e0-9f4b-11ec-b909-0242ac120002",
    "os_type" : "windows",
    "product_id" : "workspace.x86.general.xlarge2",
    "subnet_id" : "0ddf778f-c0fe-4717-9251-001caee7c95e",
    "system_disk_type" : "SSD",
    "system_disk_size" : 10,
    "is_vdi" : false,
    "extra_session_type" : "CPU",
    "extra_session_size" : 1,
    "app_type" : "SESSION_DESKTOP_APP",
    "create_time" : "2022-03-07T10:40:43.858Z",
    "update_time" : "2022-03-07T10:40:43.858Z",
    "storage_mount_policy" : "ANY",
    "enterprise_project_id" : "0",
    "primary_server_group_ids" : [ "string" ],
    "secondary_server_group_ids" : [ "string" ],
    "server_group_status" : false,
    "site_type" : "CENTER",
    "site_id" : "ae985216-83fa-46b6-ab03-a36dcb3dd05a",
    "app_group_count" : "1"
  } ]
}
```
#### 状态码
| 状态码 | 描述                      |
|:---|:---|
| 200 | 成功响应。                   |
| 400 | 由于包含语法错误，当前请求无法被服务器理解。  |
| 401 | 鉴权失败。                   |
| 403 | 没有操作权限。                 |
| 404 | 找不到资源。                  |
| 405 | 请求中指定的方法不被允许。           |
| 500 | 服务内部错误，具体返回错误码请参见错误码说明。 |
| 503 | 服务不可用。                  |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode_0.html)。