计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

创建VPN网关

功能介绍

创建VPN网关。

调用方法

请参见如何调用API

URI

POST /v5/{project_id}/vpn-gateways
表1 参数说明

名称

类型

是否必选

描述

project_id

String

项目ID,可以通过获取项目ID获取项目ID。

请求消息

  • 请求参数
    表2 请求参数

    名称

    类型

    是否必选

    描述

    vpn_gateway

    CreateVgwRequestBodyContent object

    VPN网关对象。

    表3 CreateVgwRequestBodyContent

    名称

    类型

    是否必选

    描述

    name

    String

    • 功能说明:VPN网关名 称。
    • 取值范围:1-64个字符,支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)、.(点)。
    • 默认值:不填时会自动生成格式为vpngw-****的名称。例如:vpngw-a45b。

    network_type

    String

    • 功能说明:VPN网关网络类型,公网(public)类型的VPN网关通过EIP与对端网关建连;私网(private)类型的VPN网关通过VPC内的私网IP与对端网关建连。
    • 取值范围:public,private。
    • 默认值:public。

    attachment_type

    String

    • 功能说明:关联模式。
    • 取值范围:vpc,er。
    • 默认值:vpc。

    vpc_id

    String

    • 功能说明:
      • 当attachment_type为vpc时,vpc_id是VPN网关关联的业务VPC的ID。
      • 当attachment_type为er时,vpc_id是VPN网关的接入VPC的ID,此时可以使用任意VPC的ID。
    • 约束:36位UUID。

      当attachment_type配置为"vpc"时必填;当attachment_type配置为"er"时可不填写,当vpc_id和access_vpc_id都填写时,access_vpc_id生效。

      vpc_id和er_id不能同时为空。

    可以通过查看VPC的ID。

    local_subnets

    Array of String

    • 功能说明:本端子网是云上子网,该子网需要通过VPN与云下对端子网进行互通。

      每个VPN网关最多填写50个本端子网,单个子网格式示例:192.168.52.0/24。

    • 约束:当attachment_type配置为"vpc"时必填,否则不填。

    connect_subnet

    String

    • 功能说明:VPN网关使用的VPC子网ID。
    • 约束:36位UUID。

      当attachment_type配置为"vpc"时必填;当attachment_type配置为"er"时可不填写,当connect_subnet和access_subnet_id都填写时,access_subnet_id生效。

      当attachment_type为er时,子网中需要有至少2个空闲IP。

      当attachment_type为vpc时,如果access_subnet_id与connect_subnet相同,则子网中需要有至少4个空闲IP;如果不同,则需要至少2个空闲IP。

    bgp_asn

    Long

    • 功能说明:VPN网关的BGP自治域编号。
    • 取值范围:1-4294967295。
    • 默认值:64512。

    flavor

    String

    • 功能说明:VPN网关的规格类型。实际可选范围请参考VPN控制台创建VPN网关页面的Specification选项。
    • 取值范围:
      • Professional1
      • Professional2
      • GM

      不同规格类型的特性,请参考《虚拟专用网络用户指南》的“产品规格”章节。

    • 默认值:Professional1。

    availability_zone_ids

    Array of String

    • 功能说明:部署VPN网关的可用区。不填时自动为VPN网关选择可用区。
    • 约束:如果VPN网关支持两个及以上的可用区时,必须填写两个可用区;支持一个可用区时填写一个;无支持可用区时不能创建VPN网关。

    enterprise_project_id

    String

    • 功能说明:企业项目ID。
    • 约束:36位UUID或者"0"。
    • 默认值:"0",表示资源属于default企业项目。

    eip1

    CreateRequestEip object

    • 功能说明:双活VPN网关表示使用的第一个EIP,主备模式网关表示主EIP。
    • 约束:network_type为public时必选,为private时不需要填写。

    eip2

    CreateRequestEip object

    • 功能说明:双活VPN网关表示使用的第二个EIP,主备模式网关表示备EIP。
    • 约束:network_type为public时必选,为private时不需要填写。

    access_vpc_id

    String

    • 功能说明:VPN网关使用的接入VPC ID。
    • 约束:36位UUID。
    • 默认值:同vpc_id字段所填的值。

      可以通过查询VPC列表查看VPC的ID。

    access_subnet_id

    String

    • 功能说明:VPN网关使用的接入VPC中的子网ID。
    • 约束:36位UUID。

      当attachment_type为er时,子网中需要有至少2个空闲IP。

      当attachment_type为vpc时,如果access_subnet_id与connect_subnet相同,则子网中需要有至少4个空闲IP;如果不同,则需要至少2个空闲IP。

    • 默认值:同connect_subnet字段所填的值。

    ha_mode

    String

    • 功能说明:网关的HA模式,"active-active"表示双活,"active-standby"表示主备。
    • 取值范围:active-active,active-standby。
    • 默认值:active-active。

    access_private_ip_1

    String

    • 功能说明:私网类型VPN网关的接入私网IP1,指定ip创建私网网关时设置,主备网关时为主ip,双活网关时为主ip1。
    • 取值范围:接入子网网段内的可分配ip。
    • 约束:需与接入ip2同时指定,不能与接入ip2重复。

    access_private_ip_2

    String

    • 功能说明:私网类型VPN网关的接入私网IP2,指定ip创建私网网关时设置,主备网关时为备ip,双活网关时为主ip2。
    • 取值范围:接入子网网段内的可分配ip。
    • 约束:需与接入ip1同时指定,不能与接入ip1重复。

    tags

    Array of VpnResourceTag objects

    • 功能说明:标签列表。
    • 约束:最多填写20个。
    表4 CreateRequestEip

    名称

    类型

    是否必选

    描述

    id

    String

    • 功能说明:EIP的ID。
    • 取值范围:36位UUID。
    • 约束:当使用已有EIP时填写,当新创建EIP时不填。

    type

    String

    • 功能说明:EIP的类型。
    • 取值范围:0-36个字符。
    • 约束:当新创建EIP场景时需要填写,否则不填。

    bandwidth_size

    Integer

    • 功能说明:EIP的带宽大小,单位:Mbit/s。每个region能够提供的EIP最大带宽不同,EIP的最大带宽受限于EIP服务,可以使用工单来提高帐户下的EIP的最大带宽。
    • 取值范围:1-1000,具体取值请参考弹性公网服务创建EIP资料。
    • 约束:当新创建EIP场景且不绑定共享带宽时需要填写,否则不填。

      flavor为Professional1时,取值不能大于300;flavor为Professional2时,取值不能大于1000;flavor为GM时,取值不能大于500。

    bandwidth_name

    String

    • 功能说明:EIP的带宽名称。
    • 取值范围:1-64个字符,支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)、.(点)。
    • 约束:当新创建EIP场景且不绑定共享带宽时需要填写,否则不填。
    • 默认值:当新创建EIP场景时,不填此字段会自动生成格式为vpngw-bandwidth-****的EIP带宽名称。例如:vpngw-bandwidth-e1fa。
    表5 VpnResourceTag

    名称

    类型

    是否必选

    描述

    key

    String

    • 功能说明:标签的键。
    • 取值范围:1-128个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。

    value

    String

    • 功能说明:标签的值。
    • 取值范围:0-255个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。
  • 请求样例
    1. 使用已有EIP创建关联VPC的VPN网关。
      POST https://{Endpoint}/v5/{project_id}/vpn-gateways
      
      {
          "vpn_gateway": {
              "vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c",
              "local_subnets": [
                  "192.168.0.0/24", "192.168.1.0/24"
              ],
              "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114",
              "eip1": {
                  "id": "cff40e5e-demo-a8df-va86-7366077bf097"
              },
              "eip2": {
                  "id": "d290f1ee-demo-a8df-va86-d701748f0851"
              }
          }
      }
    2. 创建私网关联VPC的VPN网关。
      POST https://{Endpoint}/v5/{project_id}/vpn-gateways
      
      {
          "vpn_gateway": {
              "vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c",
              "local_subnets": [
                  "192.168.0.0/24", "192.168.1.0/24"
              ],
              "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114",
              "network_type": "private"
          }
      }

响应消息

  • 响应参数

    返回状态码为 201: successful operation。

    表6 响应Body参数列表

    名称

    类型

    描述

    vpn_gateway

    ResponseVpnGateway object

    VPN网关对象。

    request_id

    String

    请求ID。

    表7 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。

    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时返回。

    connect_subnet

    String

    VPN网关所使用的VPC中的一个子网ID。

    bgp_asn

    Long

    VPN网关的BGP自治域编号。

    flavor

    String

    • 功能说明:VPN网关的规格类型。实际可选范围请参考VPN控制台创建VPN网关页面的Specification选项。
    • 取值范围:

      v300:最大转发带宽300Mbps。该取值已经废弃,但仍然保留兼容性支持,建议不要使用该取值。

      v1g:最大转发带宽1Gbps。该取值已经废弃,但仍然保留兼容性支持,建议不要使用该取值。

      Professional1:最大转发带宽300Mbps。

      Professional2:最大转发带宽1Gbps。

      GM: 最大转发带宽500Mbps。

    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"。

    access_vpc_id

    String

    • 功能说明:VPN网关使用的接入VPC ID。
    • 格式:36位UUID。

    access_subnet_id

    String

    • 功能说明:VPN网关使用的接入VPC中的子网ID。
    • 格式:36位UUID。

    ha_mode

    String

    • 功能说明:网关的HA模式,"active-active"表示双活,"active-standby"表示主备。
    • 取值范围:active-active,active-standby。
    • 默认值:active-active。

    tags

    Array of VpnResourceTag objects

    标签列表。

    表8 VpnResourceTag

    名称

    类型

    描述

    key

    String

    • 功能说明:标签的键。
    • 取值范围:1-128个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。

    value

    String

    • 功能说明:标签的值。
    • 取值范围:0-255个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。
    表9 PolicyTemplate

    名称

    类型

    描述

    ike_policy

    IkePolicy object

    ike 策略对象。

    ipsec_policy

    IpsecPolicy object

    ipsec 策略对象。

    表10 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,单位:秒。
    表11 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,单位:秒。
  • 响应样例
    1. 使用已有EIP创建关联VPC的VPN网关的响应。
      {
          "vpn_gateway": {
              "id": "134f9fb1-demo-a8df-va86-2040a5c13325",
              "name": "vpngw-9f24",
              "network_type": "public",
              "attachment_type": "vpc",
              "vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa",
              "local_subnets": ["192.168.0.0/24"],
              "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114",
              "bgp_asn": 64512,
              "flavor": "Professional1",
              "connection_number": 200,
              "used_connection_number": 0,
              "used_connection_group": 0,
              "enterprise_project_id": "0",
              "access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa",
              "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114",
              "ha_mode": "active-active"
          },
          "request_id": "7b37532a-d6e4-46b9-98dc-9169ec2ca58f"
      }
    2. 创建私网关联VPC的VPN网关的响应。
      {
          "vpn_gateway": {
              "id": "80ac167b-demo-a8df-va86-a9a2a23223b8",
              "name": "vpngw-1234",
              "network_type": "private",
              "attachment_type": "vpc",
              "vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c",
              "local_subnets": ["192.168.0.0/24", "192.168.1.0/24"],
              "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114",
              "bgp_asn": 65533,
              "flavor": "Professional2",
              "connection_number": 200,
              "used_connection_number": 0,
              "used_connection_group": 0,
              "enterprise_project_id": "0",
              "access_vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c",
              "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114",
              "ha_mode": "active-active"
          },
          "request_id": "cd71cade-bfbd-410b-b672-4bfe46cfc311"
      }

状态码

请参见状态码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容