响应消息 响应参数 返回状态码为 200: successful operation。 表7 响应Body参数列表 名称 类型 描述 vpn_gateway ResponseVpnGateway object vpn_gateway对象。 request_id String 请求ID。 表8 ResponseVpnGateway 名称 类型 描述 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。 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时，vpc_id是VPN网关的接入VPC的ID。 local_subnets Array of String 本端子网。本端子网是云上子网，该网段需要通过VPN与用户侧网络进行互通。单个网段格式示例：192.168.52.0/24。仅当attachment_type为vpc时返回。 connect_subnet String VPN网关所使用的VPC中的一个子网ID。 bgp_asn Long VPN网关的BGP自治域编号。 flavor String 功能说明：VPN网关的规格类型: 取值范围： Basic：最大转发带宽100Mbps。 Professional1：最大转发带宽300Mbps。 Professional1-NonFixedIP：最大转发带宽300Mbps。 Professional2：最大转发带宽1Gbps。 Professional2-NonFixedIP：最大转发带宽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:ssZ。 updated_at String 最后一次更新时间。在VPN网关的状态为ACTIVE时返回。 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ。 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 标签列表。 表9 ResponseEip 名称 类型 描述 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，如： CS 22********LIBIV:00301-******-0--0:br-iaas-odin1:0605768a************c006c7e484aa。 type String 功能说明：EIP的类型。 取值范围：可查看申请EIP表6中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。 表10 PolicyTemplate 名称 类型 描述 ike_policy IkePolicy object ike策略对象。 ipsec_policy IpsecPolicy object ipsec策略对象。 表11 IkePolicy 名称 类型 描述 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，单位：秒。 表12 IpsecPolicy 名称 类型 描述 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，单位：秒。 表13 VpnResourceTag 名称 类型 描述 key String 功能说明：标签的键。 取值范围：1-128个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 value String 功能说明：标签的值。 取值范围：0-255个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 响应样例 更新固定IP接入VPN网关的响应。 { "vpn_gateway": { "id": "620d99b8-demo-a8df-va86-200b868f2d7d", "name": "vpngw-4321", "attachment_type": "vpc", "network_type": "public", "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": "2022-09-15T08:56:09.386Z", "updated_at": "2022-09-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" } 更新非固定IP接入VPN网关的响应。 { "vpn_gateway":{ "id":"620d99b8-demo-a8df-va86-200b868f2d7d", "name":"vpngw-4321", "attachment_type":"vpc", "network_type":"public", "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":"2022-09-15T08:56:09.386Z", "updated_at":"2022-09-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" } 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" }

请求消息 请求参数 表2 请求参数 名称 类型 是否必选 描述 vpn_gateway UpdateVgwRequestBodyContent object 是 vpn_gateway对象。 表3 UpdateVgwRequestBodyContent 名称 类型 是否必选 描述 name String 否 功能说明：VPN网关名称。 取值范围：1-64个字符，支持数字、英文字母、中文（\u4e00 - \u9fa5）、_（下划线）、-（中划线）、.（点）。 local_subnets Array of String 否 功能说明：本端子网。本端子网是云上子网，该网段需要通过VPN与用户侧网络进行互通。单个网段格式示例：192.168.52.0/24。 约束：当attachment_type配置为"vpc"时可填写，否则不填。每个VPN网关最多填写50个本端子网。 eip_id_1 String 否 功能说明：有效的EIP的ID，表示绑定新的EIP作为双活VPN网关使用的第一个EIP或主备VPN网关的主EIP。绑定新的EIP前必须先解绑掉原有的EIP。可以通过解绑弹性公网IP解绑VPN网关使用的EIP。 约束：36位UUID，当network_type配置为public时可填写，否则不填。 eip_id_2 String 否 功能说明：有效的EIP的ID，表示绑定新的EIP作为双活VPN网关使用的第二个EIP或主备VPN网关的备EIP。绑定新的EIP前必须先解绑掉原有的EIP。可以通过解绑弹性公网IP解绑VPN网关使用的EIP。 约束：36位UUID，当network_type配置为public时可填写，否则不填。 policy_template PolicyTemplate object 否 功能说明：策略模板。 约束：只有当VPN网关的规格为Professional1-NonFixedIP或Professional2-NonFixedIP时使用，用于更新网关的策略模板。 表4 PolicyTemplate 名称 类型 描述 ike_policy IkePolicy object ike 策略对象。 ipsec_policy IpsecPolicy object ipsec 策略对象。 表5 IkePolicy 名称 类型 描述 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，单位：秒。 表6 IpsecPolicy 名称 类型 描述 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，单位：秒。 请求样例 更新固定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" } } 更新非固定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: 查询成功。 表2 响应Body参数列表 名称 类型 描述 p2c_vpn_gateway p2c_vpn_gateway object vpn_gateway对象 request_id String 请求ID 表3 p2c_vpn_gateway 名称 类型 描述 id String 功能说明：P2C VPN网关ID 格式：36位UUID name String 功能说明：P2C VPN网关名称 取值范围：1-64个字符，支持数字、英文字母、中文（\u4e00 - \u9fa5）、_（下划线）、-（中划线） status String 功能说明：P2C VPN网关状态 取值范围： PENDING_CREATE：创建中 PENDING_UPDATE：更新中 PENDING_DELETE：删除中 ACTIVE：正常 FAULT：异常 FROZEN：冻结 vpc_id String P2C VPN网关所连接的VPC的ID connect_subnet String P2C VPN网关所使用的VPC子网ID flavor String 功能说明：P2C VPN网关的规格类型 取值范围: Professional1：专业型1 availability_zone_ids Array of strings 可用区列表 eip ResponseEipInfo object 网关绑定的EIP信息 max_connection_number Integer 功能说明：最多支持同时在线的客户端连接数 取值范围：1~500 current_connection_number Integer 当前建连的客户端连接数 enterprise_project_id String 企业项目ID tags Array of VpnResourceTag objects 标签列表 order_id String 订单ID admin_state_up Boolean 功能说明：冻结状态 取值范围： true：未冻结 false：冻结 frozen_effect Integer 功能说明：冻结影响，标识该资源冻结后是否可以删除 取值范围： 0：未冻结 1：冻结可删除 2：冻结不可删除 created_at String 功能说明：创建时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ updated_at String 功能说明：最后一次更新时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ 表4 ResponseEipInfo 名称 类型 描述 id String 功能说明：EIP的ID 格式：36位UUID 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的类型 取值范围：可查看申请EIP表6中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：独享带宽 表5 VpnResourceTag 名称 类型 描述 key String 功能说明：标签的键。 取值范围：1-128个字符，支持任意语种字母、数字、空格和_.:=+-@，但首尾不能含有空格，不能以_sys_开头。 value String 功能说明：标签的值。 取值范围：0-255个字符，支持任意语种字母、数字、空格和_.:/=+-@。 响应样例 { "p2c_vpn_gateway": { "id": "6d526e5f-a0c6-44b6-a785-000000000000", "name": "p2c-vpngw-0000", "status": "ACTIVE", "vpc_id": "05b9d7de-9acd-4a05-b497-1a3c75afaa0a", "connect_subnet": "1948ce22-ddc5-4fb6-87b8-dfcc9b176b51", "flavor": "Professional1", "availability_zone_ids": [ "cn-south-1f", "cn-south-1e" ], "eip": { "id": "f0bac06a-88a7-4d37-8e2e-c37691ee4ba2", "ip_version": 4, "ip_billing_info": "CS*********JWT1O:OFFI*************5078:cn-south-1:47190474************98781092d16c", "type": "5_youxuanbgp", "ip_address": "215.255.4.120", "charge_mode": "bandwidth", "bandwidth_id": "3456471c-9dac-40f6-8344-daca14fbd81e", "bandwidth_size": 20, "bandwidth_name": "p2c-vpngw-bandwidth-bd61", "bandwidth_billing_info": "CS*********JWT1O:OFFI*************5078:cn-south-1:47190474************98781092d16c", "share_type": "PER" }, "max_connection_number": 10, "current_connection_number": 0, "enterprise_project_id": "0", "tags": [], "order_id": "CS**********JWT1O", "admin_state_up": true, "frozen_effect": 0, "created_at": "2024-06-14T10:24:12.147Z", "updated_at": "2024-06-14T10:24:12.147Z" }, "request_id": "2ddd2f6107a8164ce6f6268bd991e57c" }

约束与限制 在VPN网关状态处于“创建中”、“更新中”、“删除中”三种状态时，不能进行VPN网关删除操作。 如果VPN网关下存在VPN连接，则无法直接删除VPN网关。您需要先删除VPN网关下的所有VPN连接，然后再删除VPN网关。 如何删除VPN连接，请参见删除VPN连接。 如果VPN网关绑定的EIP计费模式为包年/包月，删除VPN网关时会同步解绑EIP。解绑后弹性公网IP继续保留，若不再使用可在网关删除后释放。 如果VPN网关绑定的EIP计费模式为按需，删除VPN网关时会同步释放EIP。 如果需要保留按需EIP，则您需要先将该EIP解绑，然后再删除VPN网关。如何解绑EIP，请参见解绑弹性公网IP。 如果VPN网关绑定了加入共享带宽的EIP，删除VPN网关时会同步释放EIP，保留共享带宽。

响应消息 响应参数 返回状态码为 200: successful operation。 表3 响应Body参数列表 名称 类型 描述 availability_zones Array of strings 可用区列表 request_id String 请求id 响应样例 { "availability_zones": [ "cn-south-1f", "cn-south-1e" ], "request_id": "c63d850876bcddbdfbd11776cce57914" }

URI GET /v5/{project_id}/p2c-vpn-gateways/availability-zones 表1 参数说明 名称 类型 是否必选 描述 project_id String 是 项目ID，可以通过获取项目ID获取项目ID 表2 请求Query参数列表 名称 类型 是否必选 描述 flavor String 否 功能说明：P2C VPN网关的规格类型 取值范围: Professional1：专业型1