网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

创建VPN连接

更新时间:2025-02-06 GMT+08:00
分享

功能介绍

创建VPN连接,连接VPN网关与对端网关。

调用方法

请参见如何调用API

URI

POST /v5/{project_id}/vpn-connection

表1 参数说明

名称

类型

是否必选

说明

project_id

String

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

请求消息

  • 请求参数
    表2 请求参数

    名称

    类型

    是否必选

    描述

    vpn_connection

    CreateVpnConnectionRequestBodyContent object

    vpn_connection对象。

    表3 CreateVpnConnectionRequestBodyContent

    名称

    类型

    是否必选

    描述

    name

    String

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

    vgw_id

    String

    • 功能说明:VPN网关ID。
    • 约束:36位UUID,当VPN网关的flavor配置为GM时,VPN网关必须已导入过VPN网关证书。

    可以通过查询VPN网关列表查看VPN网关的ID。

    vgw_ip

    String

    • 功能说明:
      • 当VPN网关的network_type配置为public时,vgw_ip为VPN网关EIP的ID。
      • 当VPN网关的network_type配置为private时,vgw_ip为VPN网关使用的接入私网IP。
    • 约束:36位UUID或点分十进制IPv4地址(如192.168.45.7)。

    可以通过查询VPN网关查看VPN网关所使用的EIP的ID或接入私网IP。

    style

    String

    • 功能说明:连接模式。
    • 取值范围:

      policy: 策略模式。

      static: 静态路由模式。

      bgp: bgp路由模式。

      policy-template: 策略模板模式。

    • 默认值:static。

    cgw_id

    String

    • 功能说明:对端网关ID。
    • 约束:36位UUID,当VPN网关的flavor配置为GM时,对端网关必须已导入过对端网关证书。

    peer_subnets

    Array of String

    • 功能说明:IPv4对端子网。
    • 约束:
      • IP协议版本号为IPv6时不填;VPN网关的关联模式为er且style字段为policy或bgp时不填;其他场景必填。
      • 部分网段是VPC预留网段,不能作为对端子网,比如100.64.0.0/10,214.0.0.0/8。
      • 每个VPN连接最多填写50个对端子网。

    peer_subnets_v6

    Array of String

    • 功能说明:IPv6对端子网。
    • 约束:
      • IP协议版本号为IPv4时不填;VPN网关的关联模式为er且style字段为policy或bgp时不填,其他场景必填。
      • 每个VPN连接最多填写50个对端子网。

    tunnel_local_address

    String

    • 功能说明:路由模式下配置在VPN网关上的tunnel接口地址。例如:169.254.76.1/30。
    • 约束:
      • 前16位必须是169.254,不能使用169.254.195.xxx。
      • 掩码长度必须是30。必须和tunnel_peer_address在同一个30掩码范围。
      • 应填写网段中的主机地址。

    tunnel_peer_address

    String

    • 功能说明:路由模式下配置在用户侧设备上的tunnel接口地址。例如:169.254.76.2/30。
    • 约束:
      • 前16位必须是169.254,不能使用169.254.195.xxx。
      • 掩码长度必须是30。必须和tunnel_local_address在同一个30掩码范围。
      • 应填写网段中的主机地址。

    enable_nqa

    Boolean

    • 功能说明:开启NQA检测。
    • 取值范围:true,false。
    • 默认值:false。
    • 约束:当style为static时填写,否则不填。

    enable_hub

    Boolean

    • 功能说明:开启分支互联。
    • 取值范围:true,false。
    • 默认值:false。
    • 约束:当style为BGP时填写,否则不填。

    psk

    String

    • 功能说明:预共享密钥。

      当VPN网关的flavor配置为GM时,此字段不用填写,否则必填。

    • 约束:8-128个字符,只能包含大写字母、小写字母、数字和特殊字符(~!@#$%^()-_+={ },./:;)且至少包含四种字符的三种。

    policy_rules

    Array of PolicyRule object

    功能说明:IPv4策略模式的策略规则组。

    约束:最多填写5个。仅当style为policy且VPN网关的IP协议版本号为IPv4时填写。

    policy_rules_v6

    Array of PolicyRule object

    功能说明:IPv6策略模式的策略规则组。

    约束:最多填写5个。仅当style为policy且VPN网关的IP协议版本号为IPv6时填写。

    ikepolicy

    IkePolicy object

    ike策略对象。

    ipsecpolicy

    IpsecPolicy object

    ipsec策略对象。

    ha_role

    String

    • 功能说明:双活模式VPN网关下创建连接可不填,主备模式VPN网关下创建连接时,'master'表示主连接,'slave'表示备连接。
    • 默认值:master。
    • 约束:主备模式VPN网关在主EIP或者主私网地址建立的连接必须填'master',在备EIP或者备私网地址建立的连接必须填'slave'。

    tags

    Array of VpnResourceTag object

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

    名称

    类型

    是否必选

    描述

    rule_index

    Integer

    • 功能说明:规则ID,用于区分配置的策略规则顺序。建议不填。
    • 取值范围:0-50。
    • 约束:不能与其他PolicyRule下的rule_index相同,ResponseVpnConnection中的rule_index可能与该值不同,因为 vpn服务会将多个destination拆成不同rule。

    source

    String

    • 功能说明:源地址网段,网段IPv4/IPv6格式需与VPN网关的IP协议版本匹配。
    • 约束:不能与其他PolicyRule下的source相同。

    destination

    Array of String

    • 功能说明:目的地址网段,网段IPv4/IPv6格式需与VPN网关的IP协议版本匹配。

      单个IPv4网段格式示例:192.168.52.0/24。

      单个IPv6网段格式示例:16af:cacc:1097::/48。

    • 约束:每个PolicyRule最多填写50个。
    表5 IkePolicy

    名称

    类型

    是否必选

    描述

    ike_version

    String

    • 功能说明:IKE版本号。
    • 取值范围:

      当VPN网关的flavor配置为GM时,取值范围为v1。

      其他场景下取值范围为v1,v2。

    • 默认值:

      当VPN网关的flavor配置为GM时,默认值为v1;

      其他场景下,默认值为v2。

    phase1_negotiation_mode

    String

    • 功能说明:协商模式。
    • 取值范围:

      当VPN网关的flavor配置为GM时,取值范围为main。

      其他场景下取值范围为main,aggressive。

      main:主模式,协商过程安全性高。

      aggressive:野蛮模式,协商快速且协商成功率高。

    • 默认值:main。
    • 约束:IKE版本为v1时填写,为v2时不填。

    authentication_algorithm

    String

    • 功能说明:认证算法。
    • 取值范围:

      当VPN网关的flavor配置为GM时,取值范围为sm3。

      其他场景下取值范围为sha2-512,sha2-384,sha2-256,sha1,md5。

      其中,sha1和md5安全性较低,请慎用。

    • 默认值:

      当VPN网关的flavor配置为GM时,默认值为sm3。

      其他场景下,默认值为sha2-256。

    encryption_algorithm

    String

    • 功能说明:加密算法。
    • 取值范围:

      当VPN网关的flavor配置为GM时,取值范围为sm4。

      其他场景下取值范围为aes-256-gcm-16,aes-128-gcm-16,aes-256,aes-192,aes-128,3des。

      其中,3des安全性较低,请慎用。

    • 默认值:

      当VPN网关的flavor配置为GM时,默认值为sm4;

      其他场景下,默认值为aes-128。

    dh_group

    String

    • 功能说明:第一阶段密钥交换使用的DH组。

      当VPN网关的flavor配置为GM时,该字段不用填写。

    • 取值范围:group1,group2,group5,group14,group15,group16,group19,group20,group21。

      其中,group1,group2,group5,group14安全性较低,请慎用。

    • 默认值:group15。

    authentication_method

    String

    • 功能说明:ike协商时的认证方法。
    • 取值范围:

      pre-share:预共享密钥。

      digital-envelope-v2:国密数字信封。

    • 默认值:pre-share。

    lifetime_seconds

    Integer

    • 功能说明:表示SA的生存周期,当该生存周期超时后IKE SA将自动更新。
    • 取值范围:60-604800,单位:秒。
    • 默认值:86400。

    local_id_type

    String

    • 功能说明:本端ID类型。

      当VPN网关的flavor配置为GM时,该字段不用填写。

    • 取值范围:
      • ip。
      • fqdn。
    • 默认值:ip。

    local_id

    String

    • 功能说明:本端ID。

      当VPN网关的flavor配置为GM时,该字段不用填写。

    • 约束:

      当local_id_type为ip时,可不填,填写需满足IPv4格式。

      当local_id_type为fqdn时,最大长度255个字符,只能由大小写字母、数字和特殊符号组成,不支持以下特殊字符:&、<、>、[、]、\、空格、?,区分大小写。

      当local_id_type为fqdn时填写,需要和对端设备的peer_id一致。

    peer_id_type

    String

    • 功能说明:对端ID类型。

      当VPN网关的flavor配置为GM时,该字段不用填写。

    • 取值范围:
      • ip。
      • fqdn。
    • 默认值:ip。

    peer_id

    String

    • 功能说明:对端ID。

      当VPN网关的flavor配置为GM时,该字段不用填写。

    • 约束:

      当local_id_type为ip时,可不填,填写需满足IPv4格式。

      当local_id_type为fqdn时,最大长度255个字符,只能由大小写字母、数字和特殊符号组成,不支持以下特殊字符:&、<、>、[、]、\、空格、?,区分大小写。

      当peer_id_type为fqdn时填写,需要和对端设备的local_id一致。

    dpd

    Dpd object

    对等体存活检测对象。

    表6 Dpd

    名称

    类型

    是否必选

    描述

    timeout

    Integer

    • 功能说明:对等体存活检测报文重传间隔。
    • 取值范围:2-60,单位:秒。
    • 默认值:15。

    interval

    Integer

    • 功能说明:对等体存活检测空闲时间。
    • 取值范围:10-3600,单位:秒。
    • 默认值:30。

    msg

    String

    • 功能说明:对等体存活检测报文格式。
    • 取值范围:

      seq-hash-notify:指定DPD报文中的载荷顺序是hash-notify。

      seq-notify-hash:指定DPD报文中的载荷顺序是notify-hash。

    • 默认值:seq-hash-notify。
    表7 IpsecPolicy

    名称

    类型

    是否必选

    描述

    authentication_algorithm

    String

    • 功能说明:认证算法。
    • 取值范围:

      当VPN网关的flavor配置为GM时,取值范围为sm3。

      其他场景下取值范围为sha2-512,sha2-384,sha2-256,sha1,md5。

      其中,sha1和md5安全性较低,请慎用。

    • 默认值:

      当VPN网关的flavor配置为GM时,默认值为sm3。

      其他场景下,默认值为sha2-256。

    encryption_algorithm

    String

    • 功能说明:加密算法。
    • 取值范围:

      当VPN网关的flavor配置为GM时,取值范围为sm4。

      其他场景下取值范围为aes-256-gcm-16,aes-128-gcm-16,aes-256,aes-192,aes-128,3des。

      其中,3des安全性较低,请慎用。

    • 默认值:

      当VPN网关的flavor配置为GM时,默认值为sm4。

      其他场景下,默认值为aes-128。

    pfs

    String

    • 功能说明:PFS使用的DH密钥组。

      当VPN网关的flavor配置为GM时,该字段不用填写。

    • 取值范围:group1,group2,group5,group14,group15,group16,group19,group20,group21,disable。

      其中,group1,group2,group5,group14安全性较低,请慎用。

    • 默认值:group15。

    transform_protocol

    String

    • 功能说明:传输协议。
    • 取值范围:

      esp:封装安全协议。

    • 默认值:esp。

    lifetime_seconds

    Integer

    • 功能说明:表示配置IPSec连接建立的隧道以时间为基准的生存周期。
    • 取值范围:30-604800,单位:秒。
    • 默认值:3600。

    encapsulation_mode

    String

    • 功能说明:报文封装模式。
    • 取值范围:

      tunnel:隧道模式。

    • 默认值:tunnel。
    表8 VpnResourceTag

    名称

    类型

    是否必选

    描述

    key

    String

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

    value

    String

    • 功能说明:标签的值。
    • 取值范围:0-255个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。
  • 请求样例
    1. 创建静态路由模式连接。
      POST https://{Endpoint}/v5/{project_id}/vpn-connection
      
      {
          "vpn_connection": {
              "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d",
              "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde",
              "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d",
              "peer_subnets": [
                  "192.168.44.0/24"
              ],
              "psk": "abcd****"
          }
      }
    2. 创建策略模式连接。
      POST https://{Endpoint}/v5/{project_id}/vpn-connection
      
      {
          "vpn_connection": {
              "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d",
              "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde",
              "style": "policy",
              "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d",
              "peer_subnets": [
                  "192.168.44.0/24"
              ],
              "psk": "abcd****",
              "policy_rules": [{
                  "rule_index": 1,
                  "source": "10.0.0.0/24",
                  "destination": [
                      "192.168.0.0/24"
                  ]
              }]
          }
      }
    3. 创建bgp路由模式连接。
      POST https://{Endpoint}/v5/{project_id}/vpn-connection
      
      {
          "vpn_connection": {
              "name": "vpn-1655",
              "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d",
              "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde",
              "style": "bgp",
              "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d",
              "peer_subnets": [
                  "192.168.44.0/24"
              ],
              "tunnel_local_address": "169.254.56.225/30",
              "tunnel_peer_address": "169.254.56.226/30",
              "psk": "abcd****",
              "ikepolicy": {
                  "ike_version": "v2",
                  "authentication_algorithm": "sha2-512",
                  "encryption_algorithm": "aes-256",
                  "dh_group": "group16",
                  "lifetime_seconds": 172800,
                  "local_id_type": "fqdn",
                  "local_id": "123***",
                  "peer_id_type": "fqdn",
                  "peer_id": "456***",
                  "dpd": {
                      "timeout": 30,
                      "interval": 60,
                      "msg": "seq-notify-hash"
                  }
              },
              "ipsecpolicy": {
                  "authentication_algorithm": "sha2-512",
                  "encryption_algorithm": "aes-256",
                  "pfs": "group16",
                  "transform_protocol": "esp",
                  "lifetime_seconds": 7200,
                  "encapsulation_mode": "tunnel"
              }
          }
      }

响应消息

  • 响应参数

    返回状态码为 201: successful operation。

    表9 响应Body参数列表

    名称

    类型

    描述

    vpn_connection

    ResponseVpnConnection object

    vpn_connection对象。

    request_id

    String

    请求ID。

    表10 ResponseVpnConnection

    名称

    类型

    描述

    id

    String

    • 功能说明:VPN连接ID。
    • 格式:36位UUID。

    name

    String

    • 功能说明:VPN连接名称。
    • 取值范围:1-64个字符,支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)。

    vgw_id

    String

    • 功能说明:VPN网关ID。
    • 格式:36位UUID。

    vgw_ip

    String

    • 功能说明: VPN网关EIP的ID或接入私网IP。
    • 格式:36位UUID或点分十进制IPv4地址(如192.168.45.7)。

    style

    String

    • 功能说明:连接模式。
    • 取值范围:

      POLICY: 策略模式。

      STATIC: 静态路由模式。

      BGP: bgp路由模式。

      POLICY-TEMPLATE: 策略模板模式。

    cgw_id

    String

    • 功能说明:对端网关ID。
    • 格式:36位UUID。

    peer_subnets

    Array of String

    IPv4对端子网。当VPN网关的关联模式为ER并且style字段为BGP或POLICY、或VPN网关的IP协议版本号为IPv6时不返回。

    peer_subnets_v6

    Array of String

    IPv6对端子网。当VPN网关的关联模式为ER并且style字段为BGP或POLICY、或VPN网关的IP协议版本号为IPv4时不返回。

    tunnel_local_address

    String

    路由模式下配置在VPN网关上的tunnel接口地址。仅当style为STATIC或BGP时有效。

    tunnel_peer_address

    String

    路由模式下配置在用户侧设备上的tunnel接口地址。仅当style为STATIC或BGP时有效。

    enable_nqa

    Boolean

    • 功能说明:开启NQA检测。仅当style为STATIC时返回。
    • 取值范围:true,false。

    policy_rules

    Array of PolicyRule objects

    IPv4策略模式的策略规则组。仅当style为POLICY且VPN网关的IP协议版本号为IPv4时返回实际的策略规则组。

    policy_rules_v6

    Array of PolicyRule objects

    IPv6策略模式的策略规则组。仅当style为POLICY且VPN网关的IP协议版本号为IPv6时返回实际的策略规则组。

    ikepolicy

    IkePolicy object

    ike策略对象。

    ipsecpolicy

    IpsecPolicy object

    ipsec策略对象。

    created_at

    String

    • 创建时间。
    • UTC时间格式:yyyy-MM-ddTHH:mm:ssZ。

    updated_at

    String

    • 最后一次更新时间。
    • UTC时间格式:yyyy-MM-ddTHH:mm:ssZ。

    enterprise_project_id

    String

    • 功能说明:企业项目ID。
    • 格式:36位UUID。与vgw_id所标识VPN网关的企业项目ID一致。

    ha_role

    String

    • 功能说明:主备模式VPN网关下的连接时,'master'表示主连接,'slave'表示备连接。双活模式下的连接ha_role都是'master'。
    • 默认值:master。

    tags

    Array of VpnResourceTag objects

    标签列表。

    表11 PolicyRule

    名称

    类型

    描述

    rule_index

    Integer

    • 功能说明:规则ID。
    • 取值范围:0-50。

    source

    String

    源地址网段。

    destination

    Array of String

    目的地址网段。单个IPv4网段格式示例:192.168.52.0/24。单个IPv6网段格式示例:16af:cacc:1097::/48。每个PolicyRule最多返回50个。

    表12 IkePolicy

    名称

    类型

    描述

    ike_version

    String

    • 功能说明:IKE版本号。
    • 取值范围:v1, v2。

    phase1_negotiation_mode

    String

    • 功能说明:协商模式。仅当IKE版本为v1时返回。
    • 取值范围:

      main:主模式,协商过程安全性高。

      aggressive:野蛮模式,协商快速且协商成功率高。

    authentication_algorithm

    String

    • 功能说明:认证算法。
    • 取值范围:sha2-512,sha2-384,sha2-256,sha1,md5,sm3。

    encryption_algorithm

    String

    • 功能说明:加密算法。
    • 取值范围:aes-256-gcm-16,aes-128-gcm-16,aes-256,aes-192,aes-128,3des,sm4。

    dh_group

    String

    • 功能说明:第一阶段密钥交换使用的DH组,当VPN网关flavor为GM时不返回。
    • 取值范围:group1,group2,group5,group14,group15,group16,group19,group20,group21。

    authentication_method

    String

    • 功能说明:ike协商时的认证方法。
    • 取值范围:

      pre-share:预共享密钥。

      digital-envelope-v2:国密数字信封。

    lifetime_seconds

    Integer

    • 功能说明:表示SA的生存周期,当该生存周期超时后IKE SA将自动更新。
    • 取值范围:60-604800,单位:秒。

    local_id_type

    String

    • 功能说明:本端ID类型,当VPN网关flavor为GM时不返回。
    • 取值范围:
      • ip。
      • fqdn。

    local_id

    String

    本端ID。当local_id_type为ip时返回创建或更新VPN连接时指定的本端ID,如果未指定本端ID则返回VPN连接所使用的VPN网关IP;当local_id_type为fqdn时返回创建或更新VPN连接时指定的本端ID。

    当VPN网关flavor为GM时不返回。

    peer_id_type

    String

    • 功能说明:对端ID类型,当VPN网关flavor为GM时不返回。
    • 取值范围:
      • ip。
      • fqdn。

    peer_id

    String

    对端ID。当peer_id_type为ip时返回创建或更新VPN连接时指定的对端ID,如果未指定则返回对端网关的IP;当peer_id_type为fqdn时返回创建或更新VPN连接时指定的对端ID。

    当VPN网关flavor为GM时不返回。

    dpd

    Dpd object

    对等体存活检测对象。

    表13 Dpd

    名称

    类型

    描述

    timeout

    Integer

    • 功能说明:对等体存活检测报文重传间隔。
    • 取值范围:2-60,单位:秒。

    interval

    Integer

    • 功能说明:对等体存活检测空闲时间。
    • 取值范围:10-3600,单位:秒。

    msg

    String

    • 功能说明:对等体存活检测报文格式。
    • 取值范围:

      seq-hash-notify:指定DPD报文中的载荷顺序是hash-notify。

      seq-notify-hash:指定DPD报文中的载荷顺序是notify-hash。

    表14 IpsecPolicy

    名称

    类型

    描述

    authentication_algorithm

    String

    • 功能说明:认证算法。
    • 取值范围:sha2-512,sha2-384,sha2-256,sha1,md5,sm3。

    encryption_algorithm

    String

    • 功能说明:加密算法。
    • 取值范围:aes-256-gcm-16,aes-128-gcm-16,aes-256,aes-192,aes-128,3des,sm4。

    pfs

    String

    • 功能说明:PFS使用的DH密钥组,当VPN网关flavor为GM时不返回。
    • 取值范围:group1,group2,group5,group14,group15,group16,group19,group20,group21,disable。

    transform_protocol

    String

    • 功能说明:传输协议。
    • 取值范围:

      esp:封装安全协议。

    lifetime_seconds

    Integer

    • 功能说明:表示配置IPSec连接建立的隧道以时间为基准的生存周期。
    • 取值范围:30-604800,单位:秒。

    encapsulation_mode

    String

    • 功能说明:报文封装模式。
    • 取值范围:

      tunnel:隧道模式。

    表15 VpnResourceTag

    名称

    类型

    描述

    key

    String

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

    value

    String

    • 功能说明:标签的值。
    • 取值范围:0-255个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。
  • 响应样例
    1. 创建静态路由模式连接的响应。
      {
          "vpn_connection": {
              "id": "98c5af8a-6ee2-4482-99a2-ae2280a6f4c3",
              "name": "vpn-b2cb",
              "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d",
              "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde",
              "style": "STATIC",
              "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d",
              "peer_subnets": ["192.168.44.0/24"],
              "tunnel_local_address": "169.254.56.225/30",
              "tunnel_peer_address": "169.254.56.226/30",
              "enable_nqa": false,
              "ikepolicy": {
                  "ike_version": "v2",
                  "authentication_algorithm": "sha2-256",
                  "encryption_algorithm": "aes-128",
                  "dh_group": "group15",
                  "authentication_method": "pre-share",
                  "lifetime_seconds": 86400,
                  "local_id_type": "ip",
                  "local_id": "10.***.***.134",
                  "peer_id_type": "ip",
                  "peer_id": "88.***.***.164",
                  "dpd": {
                      "timeout": 15,
                      "interval": 30,
                      "msg": "seq-hash-notify"
                  }
              },
              "ipsecpolicy": {
                  "authentication_algorithm": "sha2-256",
                  "encryption_algorithm": "aes-128",
                  "pfs": "group15",
                  "transform_protocol": "esp",
                  "lifetime_seconds": 3600,
                  "encapsulation_mode": "tunnel"
              },
              "created_at": "2022-11-26T13:41:34.626Z",
              "updated_at": "2022-11-26T13:41:34.626Z",
              "enterprise_project_id": "0",
              "ha_role":"master"
          },
          "request_id": "f91082d4-6d49-479c-ad1d-4e552a9f5cae"
      }
    2. 创建策略模式连接的响应。
      {
          "vpn_connection": {
              "id": "98c5af8a-demo-a8df-va86-ae2280a6f4c3",
              "name": "vpn-799d",
              "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d",
              "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde",
              "style": "POLICY",
              "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d",
              "peer_subnets": ["192.168.44.0/24"],
              "tunnel_local_address": "169.254.56.225/30",
              "tunnel_peer_address": "169.254.56.226/30",
              "policy_rules": [{
                  "rule_index": 1,
                  "source": "10.0.0.0/24",
                  "destination": [
                      "192.168.44.0/24"
                  ]
              }],
              "ikepolicy": {
                  "ike_version": "v2",
                  "authentication_algorithm": "sha2-256",
                  "encryption_algorithm": "aes-128",
                  "dh_group": "group15",
                  "authentication_method": "pre-share",
                  "lifetime_seconds": 86400,
                  "local_id_type": "ip",
                  "local_id": "10.***.***.134",
                  "peer_id_type": "ip",
                  "peer_id": "88.***.***.164",
                  "dpd": {
                      "timeout": 15,
                      "interval": 30,
                      "msg": "seq-hash-notify"
                  }
              },
              "ipsecpolicy": {
                  "authentication_algorithm": "sha2-256",
                  "encryption_algorithm": "aes-128",
                  "pfs": "group15",
                  "transform_protocol": "esp",
                  "lifetime_seconds": 3600,
                  "encapsulation_mode": "tunnel"
              },
              "created_at": "2022-11-26T13:41:34.626Z",
              "updated_at": "2022-11-26T13:41:34.626Z",
              "enterprise_project_id": "0",
              "ha_role":"master"
          },
          "request_id": "f91082d4-6d49-479c-ad1d-4e552a9f5cae"
      }
    3. 创建bgp路由模式连接的响应。
      {
          "vpn_connection": {
              "id": "98c5af8a-demo-a8df-va86-ae2280a6f4c3",
              "name": "vpn-1655",
              "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d",
              "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde",
              "style": "BGP",
              "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d",
              "peer_subnets": ["192.168.44.0/24"],
              "tunnel_local_address": "169.254.56.225/30",
              "tunnel_peer_address": "169.254.56.226/30",
              "ikepolicy": {
                  "ike_version": "v2",
                  "authentication_algorithm": "sha2-512",
                  "encryption_algorithm": "aes-256",
                  "dh_group": "group16",
                  "authentication_method": "pre-share",
                  "lifetime_seconds": 172800,
                  "local_id_type": "fqdn",
                  "local_id": "123***",
                  "peer_id_type": "fqdn",
                  "peer_id": "456***",
                  "dpd": {
                      "timeout": 30,
                      "interval": 60,
                      "msg": "seq-notify-hash"
                  }
              },
              "ipsecpolicy": {
                  "authentication_algorithm": "sha2-512",
                  "encryption_algorithm": "aes-256",
                  "pfs": "group16",
                  "transform_protocol": "esp",
                  "lifetime_seconds": 7200,
                  "encapsulation_mode": "tunnel"
              },
              "created_at": "2022-11-26T13:41:34.626Z",
              "updated_at": "2022-11-26T13:41:34.626Z",
              "enterprise_project_id": "0",
              "ha_role":"master"
          },
          "request_id": "f91082d4-6d49-479c-ad1d-4e552a9f5cae"
      }

状态码

请参见状态码

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容