
# 修改服务器组 - UpdateServerGroup
#### 功能介绍
修改服务器组。
- ![](https://support.huaweicloud.com/api-workspace/public_sys-resources/note_3.0-zh-cn.png)
  修改服务器组的镜像，系统盘大小，OU信息后，已创建的服务器配置不变，新添加的服务器会使用新的配置创建。修改最大会话数后，用户接入服务器组时，会按照最新的配置进行路由计算。 
 
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/WorkspaceApp/doc?api=UpdateServerGroup)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                          | 访问级别  | 资源类型（\*为必须）    | 条件键                                                                                                                                                                                                                                                                                                                                                           | 别名 | 依赖的授权项          |
  |:---|:---|:---|:---|:---|:---|
  | workspace:serverGroup:update | Write | serverGroup \* | - g:ResourceTag/\<tag-key\>   - g:EnterpriseProjectId    | -  | ims:images:list |
     
  
 
#### URI
PATCH /v1/{project_id}/app-server-groups/{server_group_id}
表1路径参数 
| 参数              | 是否必选 | 参数类型   | 描述        |
|:---|:---|:---|:---|
| project_id      | 是    | String | 项目唯一标识。   |
| server_group_id | 是    | String | 服务器组唯一标识。 |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                             |
|:---|:---|:---|:---|
| X-Auth-Token | 否    | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
   
表3请求Body参数 
| 参数                   | 是否必选 | 参数类型                                                                      | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|:---|:---|:---|:---|
| name                 | 否    | String                                                                    | 服务器组名称，名称需满足如下规则: 1. 由中文，英文大小写，数字，_-组成，不能有空格。   2. 长度范围1\~64个字符。                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| description          | 否    | String                                                                    | 服务器组描述。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| route_policy         | 否    | [RoutePolicyDetail] object | 路由策略。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| storage_mount_policy | 否    | String                                                                    | 用户访问APS的应用时，对应NAS存储目录在APS上的挂载策略。 - *USER* - 仅挂载个人目录。   - *SHARE* - 仅挂载共享目录。   - *ANY* - 挂载目录不做限制(个人和共享NAS存储目录都会自动挂载)。                                                                                                                                                                                                                                                                               |
| image_id             | 否    | String                                                                    | 服务器组关联的镜像ID，更新镜像ID只对组下新创建的云服务器生效。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| image_product_id     | 否    | String                                                                    | 服务器组的镜像的productId。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| image_type           | 否    | String                                                                    | 镜像类型： - *gold* - 云市场镜像   - *public* - 公共镜像   - *private* - 私有镜像   - *shared* - 共享镜像   - *other* - 其他                              |
| system_disk_type     | 否    | String                                                                    | 磁盘类型，获取可用磁盘类型详见接口磁盘管理ListVolumeType。 - *ESSD* - 极速型SSD   - *SSD* - 超高IO   - *GPSSD* - 通用型SSD   - *SAS* - 高IO   - *SATA* - 普通IO    |
| system_disk_size     | 否    | Integer                                                                   | 磁盘容量，单位GB。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ou_name              | 否    | String                                                                    | 默认组织名称。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| app_type             | 否    | String                                                                    | 服务器组应用类型： - *SESSION_DESKTOP_APP* - 会话桌面app   - *COMMON_APP* - 普通app                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| server_group_status  | 否    | Boolean                                                                   | 服务器是否处于禁用状态： - *true* - 启用状态   - *false* - 禁用状态                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
   
 表4RoutePolicyDetail 
| 参数            | 是否必选 | 参数类型    | 描述               |
|:---|:---|:---|:---|
| max_session   | 否    | Integer | 单台服务器最大的连接会话数。   |
| cpu_threshold | 否    | Integer | cpu使用率阈值，单位为%。   |
| gpu_threshold | 否    | Integer | gpu显存使用率阈值，单位为%。 |
| mem_threshold | 否    | Integer | 内存使用率阈值，单位为%。    |
   
#### 响应参数
**状态码：200**
操作成功。
**状态码：400**
表5响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：401**
表6响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：403**
表7响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：404**
表8响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：405**
表9响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：500**
表10响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：503**
表11响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
#### 请求示例
```
PATCH /v1/a4da8115c9d8464ead3a38309130523f/app-server-groups/bc05da52-89df-45ba-8146-13fe3ce7c45a
{
  "name" : "TEST"
}
```
#### 响应示例
**状态码：200**
操作成功。
```
null
```
#### 状态码
| 状态码 | 描述                      |
|:---|:---|
| 200 | 操作成功。                   |
| 400 | 由于包含语法错误，当前请求无法被服务器理解。  |
| 401 | 鉴权失败。                   |
| 403 | 没有操作权限。                 |
| 404 | 找不到资源。                  |
| 405 | 请求中指定的方法不被允许。           |
| 500 | 服务内部错误，具体返回错误码请参见错误码说明。 |
| 503 | 服务不可用。                  |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode_0.html)。
