# 更新VPN网关 - UpdateVPNGateway #### 功能介绍 根据VPN网关ID，更新指定的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:update | write | vpnGateways | - [g:EnterpriseProjectId](https://support.huaweicloud.com/usermanual-iam5/iam_01_0934.html#section2) - [g:ResourceTag/\](https://support.huaweicloud.com/usermanual-iam5/iam_01_0934.html#section2) - [vpn:AssociatePublicIp](https://support.huaweicloud.com/usermanual-iam5/iam_01_0934.html#section2) | - | - eip:bandwidths:get - eip:publicIps:associateInstance - eip:publicIps:disassociateInstance - eip:publicIps:get - eip:publicIps:update | #### URI PUT /v5/{project_id}/vpn-gateways/{vgw_id} 表1参数说明 | 名称 | 类型 | 是否必选 | 说明 | |:---|:---|:---|:---| | project_id | String | 是 | 项目ID，可以通过[获取项目ID](https://support.huaweicloud.com/api-vpn/vpn_api_0051.html)获取项目ID。 | | vgw_id | String | 是 | VPN网关实例ID。 | #### 请求消息 - 请求参数 表2请求参数 | 名称 | 类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | vpn_gateway | [UpdateVgwRequestBodyContent] object | 是 | vpn_gateway对象。 | 表3UpdateVgwRequestBodyContent | 名称 | 类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | name | String | 否 | - 功能说明：VPN网关名称。 - 取值范围：1-64个字符，支持数字、英文字母、中文（\\u4e00 - \\u9fa5）、_（下划线）、-（中划线）、.（点）。 | | local_subnets | Array of String | 否 | - 功能说明：IPv4本端子网。本端子网是云上子网，该网段需要通过VPN与用户侧网络进行互通。单个网段格式示例：192.168.52.0/24。 - 约束：当attachment_type配置为"vpc"时、且ip_version配置为"ipv4"时可填写，否则不填。每个VPN网关最多填写50个本端子网。 | | local_subnets_v6 | Array of String | 否 | - 功能说明：IPv6本端子网，本端子网是云上子网，该子网需要通过VPN与云下对端子网进行互通。单个子网格式示例：16af:cacc:1097::/48。 - 约束：当attachment_type配置为"vpc"时、且ip_version配置为"ipv6"时可填写，否则不填。每个VPN网关最多填写50个本端子网。 | | eip_id_1 | String | 否 | - 功能说明：有效的EIP的ID，表示绑定新的EIP作为双活VPN网关使用的第一个EIP或主备VPN网关的主EIP。绑定新的EIP前必须先解绑掉原有的EIP。可以通过[解绑弹性公网IP](https://support.huaweicloud.com/api-eip/DisassociatePublicips.html)解绑VPN网关使用的EIP。 - 约束：36位UUID，当network_type配置为public时可填写，否则不填。 | | eip_id_2 | String | 否 | - 功能说明：有效的EIP的ID，表示绑定新的EIP作为双活VPN网关使用的第二个EIP或主备VPN网关的备EIP。绑定新的EIP前必须先解绑掉原有的EIP。可以通过[解绑弹性公网IP](https://support.huaweicloud.com/api-eip/DisassociatePublicips.html)解绑VPN网关使用的EIP。 - 约束：36位UUID，当network_type配置为public时可填写，否则不填。 | | policy_template | [PolicyTemplate] object | 否 | - 功能说明：策略模板。 - 约束：只有当VPN网关的规格为Professional1-NonFixedIP或Professional2-NonFixedIP时使用，用于更新网关的策略模板。 | 表4PolicyTemplate | 名称 | 类型 | 描述 | |:---|:---|:---| | ike_policy | [IkePolicy] object | ike 策略对象。 | | ipsec_policy | [IpsecPolicy] object | ipsec 策略对象。 | 表5IkePolicy | 名称 | 类型 | 描述 | |:---|:---|:---| | encryption_algorithm | String | - 功能说明：加密算法。 - 取值范围：aes-256-gcm-16，aes-128-gcm-16，aes-256，aes-192，aes-128。 | | dh_group | String | - 功能说明：第一阶段密钥交换使用的DH组。 - 取值范围：group14，group15，group16，group19，group20，group21，disable。 | | authentication_algorithm | String | - 功能说明：认证算法。 - 取值范围：sha2-512，sha2-384，sha2-256。 | | lifetime_seconds | Integer | - 功能说明：表示SA的生存周期，当该生存周期超时后IKE SA将自动更新。 - 取值范围：60-604800，单位：秒。 | 表6IpsecPolicy | 名称 | 类型 | 描述 | |:---|:---|:---| | authentication_algorithm | String | - 功能说明：认证算法。 - 取值范围：sha2-512，sha2-384，sha2-256。 | | encryption_algorithm | String | - 功能说明：加密算法。 - 取值范围：aes-256-gcm-16，aes-128-gcm-16，aes-256，aes-192，aes-128。 | | pfs | String | - 功能说明：PFS使用的DH密钥组。 - 取值范围：group14，group15，group16，group19，group20，group21，disable。 | | lifetime_seconds | Integer | - 功能说明：表示配置IPSec连接建立的隧道以时间为基准的生存周期。 - 取值范围：30-604800，单位：秒。 | - 请求样例 1. 更新固定IP接入网关。 ``` PUT https://{Endpoint}/v5/{project_id}/vpn-gateways/{vgw_id} { "vpn_gateway": { "name": "vpngw-4321", "local_subnets": [ "192.168.0.0/24" ], "eip_id_1": "f1469b4a-demo-a8df-va86-bb7de91cf493", "eip_id_2": "6ad8e297-demo-a8df-va86-da0f885ccb98" } } ``` 2. 更新非固定IP接入VPN网关策略模板。 ``` PUT https://{Endpoint}/v5/{project_id}/vpn-gateways/{vgw_id} { "vpn_gateway":{ "policy_template":{ "ike_policy":{ "authentication_algorithm":"sha2-256", "encryption_algorithm":"aes-128-gcm-16", "dh_group":"group21", "lifetime_seconds":86400 }, "ipsec_policy":{ "authentication_algorithm":"sha2-256", "encryption_algorithm":"aes-128-gcm-16", "pfs":"disable", "lifetime_seconds":3600 } } } } ``` #### 响应消息 - 响应参数 返回状态码为 200: successful operation。 表7响应Body参数列表 | 名称 | 类型 | 描述 | |:---|:---|:---| | vpn_gateway | [ResponseVpnGateway] object | vpn_gateway对象。 | | request_id | String | 请求ID。 | 表8ResponseVpnGateway | 名称 | 类型 | 描述 | |:---|:---|:---| | id | String | - 功能说明：VPN网关ID。 - 格式：36位UUID。 | | name | String | - 功能说明：VPN网关名称。 - 取值范围：1-64个字符，包括数字、英文字母、中文(\\u4e00 - \\u9fa5)、_(下划线)、-(中划线)。 | | network_type | String | - 功能说明：VPN网关网络类型。 - 取值范围： public：公网。 private：私网。 - 默认值：public。 | | attachment_type | String | - 功能说明：关联模式。 - 取值范围： vpc：虚拟私有云。 er：企业路由器。 | | ip_version | String | - 功能说明：VPN网关的IP协议版本。 - 取值范围：ipv4、ipv6。 | | certificate_id | String | - 功能说明：证书ID。 - 格式：36位UUID。 | | er_id | String | VPN网关所连接的ER实例的ID。仅当attachment_type为er时返回。 | | vpc_id | String | - 当attachment_type为vpc时，vpc_id是VPN网关关联的业务VPC的ID。 - 当attachment_type为er时，不返回此字段。可以通过access_vpc_id字段查看VPN网关的接入VPC的ID。 | | local_subnets | Array of String | 本端子网。本端子网是云上子网，该网段需要通过VPN与用户侧网络进行互通。单个网段格式示例：192.168.52.0/24。仅当attachment_type为vpc且ip_version为ipv4时返回。 | | connect_subnet | String | VPN网关所使用的VPC中的一个子网ID。 | | bgp_asn | Long | VPN网关的BGP自治域编号。 | | flavor | String | - 功能说明：VPN网关的规格类型: - 取值范围： Basic：最大转发带宽100Mbps。 Professional1：最大转发带宽300Mbps。 Professional2：最大转发带宽1Gbps。 GM：最大转发带宽500Mbps。 | | availability_zone_ids | Array of String | 部署VPN网关的可用区。当指定了可用区时则返回；当未指定可用区时，在VPN网关的状态为ACTIVE时返回。 | | connection_number | Integer | VPN网关下的最大VPN连接数。 | | used_connection_number | Integer | VPN网关下当前已经使用的VPN连接数。 | | used_connection_group | Integer | VPN网关下当前已经使用的VPN连接组个数。同一用户网关入云的两条连接组成一个连接组。VPN网关默认支持10个免费的VPN连接组。 | | enterprise_project_id | String | - 功能说明：企业项目ID。 - 格式：36位UUID。创建时不传则返回"0"，表示资源属于default企业项目。 注："0"并不是真实存在的企业项目ID。 | | eip1 | [ResponseEip] object | 双活VPN网关表示使用的第一个EIP，主备VPN网关表示主EIP。在VPN网关的状态为ACTIVE时返回。 | | eip2 | [ResponseEip] object | 双活VPN网关表示使用的第二个EIP，主备VPN网关表示备EIP。在VPN网关的状态为ACTIVE时返回。 | | created_at | String | - 创建时间。在VPN网关的状态为ACTIVE时返回。 - UTC时间格式：*yyyy-MM-ddTHH:mm:ss.SSSZ。* | | updated_at | String | - 最后一次更新时间。在VPN网关的状态为ACTIVE时返回。 - UTC时间格式：*yyyy-MM-ddTHH:mm:ss.SSSZ。* | | access_vpc_id | String | - 功能说明：VPN网关使用的接入VPC ID。 - 格式：36位UUID。 | | access_subnet_id | String | - 功能说明：VPN网关使用的接入VPC中的子网ID。 - 格式：36位UUID。 | | access_private_ip_1 | String | 私网类型VPN网关的接入私网IP，VPN网关使用该私网IP与对端网关建连。双活网关表示使用的第一个私网地址，主备表示主私网地址。 示例：192.168.52.9。仅当network_type为private时返回。 | | access_private_ip_2 | String | 私网类型VPN网关的接入私网IP，VPN网关使用该私网IP与对端网关建连。双活网关表示使用的第二个私网地址，主备表示备私网地址。 示例：192.168.52.9。仅当network_type为private时返回。 | | ha_mode | String | - 功能说明：网关的HA模式，"active-active"表示双活，"active-standby"表示主备。 - 取值范围：active-active，active-standby。 | | policy_template | [PolicyTemplate] object | 非固定IP接入VPN网关的策略模板配置，只有在规格为非固定IP接入VPN网关时返回。 | | tags | Array of [VpnResourceTag] objects | 标签列表。 | 表9ResponseEip | 名称 | 类型 | 描述 | |:---|:---|:---| | id | String | - 功能说明：EIP的ID。 - 格式：36位UUID。当使用默认企业项目时返回"0"。 | | ip_version | Integer | - 功能说明：EIP版本。 - 取值范围：4。 | | ip_billing_info | String | - 功能说明：EIP的订单信息。包年/包月EIP才会返回订单信息，按需计费的EIP不返回。 - 格式：order_id:product_id:region_id:project_id，如： CS22\*\*\*\*\*\*\*\*LIBIV:00301-\*\*\*\*\*\*-0--0:br-iaas-odin1:0605768a\*\*\*\*\*\*\*\*\*\*\*\*c006c7e484aa。 | | type | String | - 功能说明：EIP的类型。 - 取值范围：5_bgp（全动态BGP），5_sbgp（静态BGP），5_youxuanbgp（优选BGP） 可查看[申请EIP](https://support.huaweicloud.com/api-eip/eip_api_0001.html)[表6](https://support.huaweicloud.com/api-vpn/vpn_api_0014.html#ZH-CN_TOPIC_0000001594352981__table65353)中type字段的取值范围。 | | ip_address | String | - 功能说明：EIP的公网IPv4地址。 - 格式：ipv4类型地址。例如：88.\*\*\*.\*\*\*.11。 | | charge_mode | String | - 功能说明：EIP的带宽计费模式。按流量计费或按带宽计费。 - 取值范围： bandwidth：按带宽计费。 traffic：按流量计费。 | | bandwidth_id | String | - 功能说明：EIP的带宽ID。 - 格式：36位UUID。 | | bandwidth_size | Integer | - 功能说明：EIP的带宽大小，单位：Mbit/s。每个region能够提供的EIP最大带宽不同，EIP的最大带宽受限于EIP服务，可以使用工单来提高账户下的EIP的最大带宽。 - 取值范围：1-1000，具体取值请参考弹性公网服务创建eip资料。 | | bandwidth_name | String | - 功能说明：EIP的带宽名称。 - 取值范围：1-64个字符，支持数字、英文字母、中文(\\u4e00 - \\u9fa5)、_(下划线)、-(中划线)、.(点)。 | | bandwidth_billing_info | String | - 功能说明：EIP的带宽订单信息。包年/包月EIP带宽才会返回带宽订单信息，按需计费的EIP带宽不返回。 - 格式：order_id:product_id:region_id:project_id，如： CS22\*\*\*\*\*\*\*\*LIBIV:00301-\*\*\*\*\*\*-0--0:br-iaas-odin1:0605768a\*\*\*\*\*\*\*\*\*\*\*\*c006c7e484aa。 | | share_type | String | - 功能说明: 带宽共享类型。 - 取值范围： PER：独享带宽。 WHOLE：共享带宽。 | 表10PolicyTemplate | 名称 | 类型 | 描述 | |:---|:---|:---| | ike_policy | [IkePolicy] object | ike策略对象。 | | ipsec_policy | [IpsecPolicy] object | ipsec策略对象。 | 表11IkePolicy | 名称 | 类型 | 描述 | |:---|:---|:---| | encryption_algorithm | String | - 功能说明：加密算法。 - 取值范围：aes-256-gcm-16，aes-128-gcm-16，aes-256，aes-192，aes-128。 | | dh_group | String | - 功能说明：第一阶段密钥交换使用的DH组。 - 取值范围：group14，group15，group16，group19，group20，group21，disable。 | | authentication_algorithm | String | - 功能说明：认证算法。 - 取值范围：sha2-512，sha2-384，sha2-256。 | | lifetime_seconds | Integer | - 功能说明：表示SA的生存周期，当该生存周期超时后IKE SA将自动更新。 - 取值范围：60-604800，单位：秒。 | 表12IpsecPolicy | 名称 | 类型 | 描述 | |:---|:---|:---| | authentication_algorithm | String | - 功能说明：认证算法。 - 取值范围：sha2-512，sha2-384，sha2-256。 | | encryption_algorithm | String | - 功能说明：加密算法。 - 取值范围：aes-256-gcm-16，aes-128-gcm-16，aes-256，aes-192，aes-128。 | | pfs | String | - 功能说明：PFS使用的DH密钥组。 - 取值范围：group14，group15，group16，group19，group20，group21，disable。 | | lifetime_seconds | Integer | - 功能说明：表示配置IPSec连接建立的隧道以时间为基准的生存周期。 - 取值范围：30-604800，单位：秒。 | 表13VpnResourceTag | 名称 | 类型 | 描述 | |:---|:---|:---| | key | String | - 功能说明：标签的键。 - 取值范围：1-128个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 | | value | String | - 功能说明：标签的值。 - 取值范围：0-255个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 | - 响应样例 1. 更新固定IP接入VPN网关的响应。 ``` { "vpn_gateway": { "id": "620d99b8-demo-a8df-va86-200b868f2d7d", "name": "vpngw-4321", "attachment_type": "vpc", "network_type": "public", "ip_version": "ipv4", "vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", "local_subnets": [ "192.168.0.0/24" ], "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114", "bgp_asn": 64512, "flavor": "Professional1", "availability_zone_ids": ["cn-south-1f", "cn-south-1e"], "connection_number": 200, "used_connection_number": 0, "used_connection_group": 0, "enterprise_project_id": "0", "eip1": { "id": "f1469b4a-demo-a8df-va86-bb7de91cf493", "ip_version": 4, "type": "5_bgp", "ip_address": "88.***.***.102", "charge_mode": "bandwidth", "bandwidth_id": "cff40e5e-demo-a8df-va86-7366077bf097", "bandwidth_size": 300, "bandwidth_name": "vpngw-bandwidth-1391" }, "eip2": { "id": "6ad8e297-demo-a8df-va86-da0f885ccb98", "ip_version": 4, "type": "5_bgp", "ip_address": "88.***.***.188", "charge_mode": "bandwidth", "bandwidth_id": "d290f1ee-demo-a8df-va86-d701748f0851", "bandwidth_size": 300, "bandwidth_name": "vpngw-bandwidth-1392" }, "created_at": "2025-06-15T08:56:09.386Z", "updated_at": "2025-06-15T11:13:13.677Z", "access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa", "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114", "ha_mode": "active-active" }, "request_id": "33a2b77a-65f9-4fa0-90bd-4bd42038eb41" } ``` 2. 更新非固定IP接入VPN网关的响应。 ``` { "vpn_gateway":{ "id":"620d99b8-demo-a8df-va86-200b868f2d7d", "name":"vpngw-4321", "attachment_type":"vpc", "network_type":"public", "ip_version": "ipv4", "vpc_id":"cb4a631d-demo-a8df-va86-ca3fa348c36c", "local_subnets":[ "192.168.0.0/24" ], "connect_subnet":"f5741286-demo-a8df-va86-2c82bd9ee114", "bgp_asn":64512, "flavor":"Professional1", "availability_zone_ids":[ "cn-south-1f", "cn-south-1e" ], "connection_number":200, "used_connection_number":0, "used_connection_group":0, "enterprise_project_id":"0", "eip1":{ "id":"f1469b4a-demo-a8df-va86-bb7de91cf493", "ip_version":4, "type":"5_bgp", "ip_address":"88.***.***.102", "charge_mode":"bandwidth", "bandwidth_id":"cff40e5e-demo-a8df-va86-7366077bf097", "bandwidth_size":300, "bandwidth_name":"vpngw-bandwidth-1391" }, "eip2":{ "id":"6ad8e297-demo-a8df-va86-da0f885ccb98", "ip_version":4, "type":"5_bgp", "ip_address":"88.***.***.188", "charge_mode":"bandwidth", "bandwidth_id":"d290f1ee-demo-a8df-va86-d701748f0851", "bandwidth_size":300, "bandwidth_name":"vpngw-bandwidth-1392" }, "created_at":"2025-06-15T08:56:09.386Z", "updated_at":"2025-06-15T11:13:13.677Z", "access_vpc_id":"0cf79a3f-demo-a8df-va86-d7ace626b0fa", "access_subnet_id":"f5741286-demo-a8df-va86-2c82bd9ee114", "ha_mode":"active-active", "policy_template":{ "ike_policy":{ "authentication_algorithm":"sha2-256", "encryption_algorithm":"aes-128-gcm-16", "dh_group":"group21", "lifetime_seconds":86400 }, "ipsec_policy":{ "authentication_algorithm":"sha2-256", "encryption_algorithm":"aes-128-gcm-16", "pfs":"disable", "lifetime_seconds":3600 } } }, "request_id":"33a2b77a-65f9-4fa0-90bd-4bd42038eb41" } ``` 3. VPN状态为"创建中"，更新失败。 ``` { "error_code":"VPN.0003", "error_msg":"resource (type=GATEWAY, ID=ff9bdca6-demo-a8df-va86-e4bcc1ea52bc) is not ready, currently CREATING", "request_id": "abafe41c-7744-41af-bf3d-4452872af799" } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-vpn/vpn_api_0052.html)。