
# 升级VPN网关 - UpgradeVPNGateway
#### 功能介绍
升级VPN网关。
#### 调用方法
请参见[如何调用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:vpnGateways:upgrade | write | vpnGateways | - [g:EnterpriseProjectId](https://support.huaweicloud.com/usermanual-iam5/iam_01_0934.html#section2)  - [g:ResourceTag/\<tag-key\>](https://support.huaweicloud.com/usermanual-iam5/iam_01_0934.html#section2)   | -  | -      |
   
#### URI
POST /v5/{project_id}/vpn-gateways/{vgw_id}/upgrade
表1请求path参数列表 
| 名称         | 类型     | 描述         |
|:---|:---|:---|
| project_id | String | 项目ID。      |
| vgw_id     | String | VPN网关实例ID。 |
   
#### 请求消息
- 请求参数
  表2UpgradeRequestBody 
  | 名称     | 类型     | 是否必选 | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
  |:---|:---|:---|:---|
  | action | String | 是    | - 功能说明：升级操作  - 取值范围： - start  - finish  - rollback     |
     
  
- 请求样例
  ```
  POST https://{Endpoint}/v5/{project_id}/vpn-gateways/{vgw_id}/upgrade
  {
      "action": "start"
  }
  ```
  
 
#### 响应消息
- 响应参数 返回状态码为202: successful operation。
  表3响应Body参数列表 
  | 名称         | 类型     | 描述    |
  |:---|:---|:---|
  | job_id     | String | 任务id。 |
  | request_id | String | 请求id。 |
     
  
- 响应样例
  ```
  {
      "job_id": "c7f1d3e3-0476-4a71-95a7-3ce8cbb969de",
      "request_id": "73f072d8-demo-a8df-va86-2a755d95636f"
  }
  ```
  
 
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-vpn/vpn_api_0052.html)。
