# 修改VPN用户组 - UpdateUserGroup
#### 功能介绍
根据VPN用户组ID，修改指定的用户组。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-vpn/vpn_api_0008.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-vpn/vpn_api_0044.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
| 授权项                               | 访问级别  | 资源类型（\*为必须）   | 条件键                       | 别名 | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| vpn:p2cVpnGateway:updateUserGroup | write | p2cVpnGateway | g:ResourceTag/\<tag-key\> | -  | -      |
   
#### URI
PUT /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups/{group_id}
表1参数说明 
| 名称            | 类型     | 是否必选 | 描述                                                                                  |
|:---|:---|:---|:---|
| project_id    | String | 是    | 项目ID，可以通过[获取项目ID](https://support.huaweicloud.com/api-vpn/vpn_api_0051.html)获取项目ID。 |
| vpn_server_id | String | 是    | VPN服务端ID。                                                                           |
| group_id      | String | 是    | 用户组ID。                                                                              |
   
#### 请求消息
- 请求参数
  表2请求参数 
  | 名称         | 类型                                                                                              | 必选 | 描述            |
  |:---|:---|:---|:---|
  | user_group | [UpdateVpnUserGroupRequestBodyContent] object | 是  | 更新VPN用户组请求对象。 |
     
   表3UpdateVpnUserGroupRequestBodyContent 
  | 名称          | 类型     | 必选 | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
  |:---|:---|:---|:---|
  | name        | String | 否  | - 功能说明：用户组名。  - 格式：1到64个字符，可使用中文、大写字母、小写字母、数字、特殊字符\`\~!@#$%\^\&\*()-_=+\\\|\[{}\];:'",\<.\>/?。  - 约束：用户组名不能重复。   |
  | description | String | 否  | - 功能说明：用户组描述。  - 格式：0到64个字符，可使用中文、大写字母、小写字母、数字、特殊字符\`\~!@#$%\^\&\*()-_=+\\\|\[{}\];:'",\<.\>/?。                                                                                                                           |
     
  - 请求样例
    ```
    PUT https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups/{group_id}
    {
      "user_group": {
        "name": "user-group1-update",
        "description": "用户组1-update"
      }
    }
    ```
    
   
 
#### 响应消息
- 响应参数 返回状态码为 200: successful operation。
  表4响应Body参数列表 
  | 名称         | 类型                                                                       | 描述        |
  |:---|:---|:---|
  | user_group | [VpnUserGroup] object | VPN用户组对象。 |
  | request_id | String                                                                   | 请求ID。     |
     
   表5VpnUserGroup 
  | 名称          | 类型      | 描述                                                                                                                                                                                                                                                                                                                                                                                                                 |
  |:---|:---|:---|
  | id          | String  | - 功能描述：VPN用户组ID。  - 格式：36位UUID。                                                                                                                                 |
  | name        | String  | 用户组名称。                                                                                                                                                                                                                                                                                                                                                                                                             |
  | description | String  | 用户组描述。                                                                                                                                                                                                                                                                                                                                                                                                             |
  | type        | String  | - 功能说明：用户组类型。  - 取值范围： Default：默认用户组。 Custom：用户创建用户组。    |
  | user_number | Integer | 用户数量。                                                                                                                                                                                                                                                                                                                                                                                                              |
  | created_at  | String  | - 功能说明：创建时间。  - UTC时间格式：*yyyy-MM-ddTHH:mm:ss.SSSZ*。                                                                                                                       |
  | updated_at  | String  | - 功能说明：更新时间。  - UTC时间格式：*yyyy-MM-ddTHH:mm:ss.SSSZ*。                                                                                                                       |
     
  - 响应示例
    ```
    {
        "user_group": {
            "id": "7625fd92-2e20-4e4d-8c56-66f110fbfaa8",
            "name": "user-group1-update",
            "description": "用户组1-update",
            "type": "Custom",
            "user_number": 0,
            "created_at": "2024-06-17T09:48:27.548Z",
            "updated_at": "2024-06-17T09:59:03.318Z"
        },
        "request_id": "6735d32bb3e35e9154caba1dbc6c2dc6"
    }
    ```
    
   
 
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-vpn/vpn_api_0052.html)。