华为云用户手册

  • 认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。 Token认证 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Token可通过调用获取用户Token获取用户Token接口获取。 云服务存在两种部署方式:项目级服务和全局级服务。 项目级服务需要获取项目级别的Token,此时请求body中auth.scope的取值为project。 全局级服务需要获取全局级别的Token,此时请求body中auth.scope的取值为domain。 调用 虚拟专用网络 API需要项目级别的Token,即调用获取用户Token获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token 后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFG....”,则调用接口时将“X-Auth-Token: ABCDEFG....”加到请求消息头即可,如下所示。 1 2 3 4 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Auth-Token: ABCDEFG.... 您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333。 AK/SK认证 AK/SK签名认证方式仅支持消息体大小在12MB以内,12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):私有访问密钥。与访问密钥ID结合使用,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。 您还可以通过这个视频教程了解如何使用AK/SK认证:https://bbs.huaweicloud.com/videos/100697。 父主题: 如何调用API
  • 响应消息 响应参数 返回状态码为 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_hub Boolean 功能说明:开启分支互联。 取值范围:true,false。 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个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。 响应样例 创建静态路由模式连接的响应。 { "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" } 创建策略模式连接的响应。 { "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" } 创建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" }
  • 响应消息 响应参数 返回状态码为 200: 查询成功。 表3 响应Body参数列表 名称 类型 描述 p2c_vpn_gateways Array of p2c_vpn_gateway objects 网关信息列表。 total_count Integer 网关总数。 page_info PageInfo object 分页查询页的信息。 request_id string 请求ID。 表4 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:冻结不可删除。 version string 功能说明:网关版本 created_at String 功能说明:创建时间。 UTC时间格式:yyyy-MM-ddTHH:mm:ssZ。 applied_at String 功能说明:生效时间 UTC时间格式:yyyy-MM-ddTHH:mm:ssZ updated_at String 功能说明:最后一次更新时间。 UTC时间格式:yyyy-MM-ddTHH:mm:ssZ。 表5 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,如: 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。 share_type String 功能说明: 带宽共享类型。 取值范围: PER:独享带宽。 表6 VpnResourceTag 名称 类型 描述 key String 功能说明:标签的键。 取值范围:1-128个字符,支持任意语种字母、数字、空格和_.:=+-@,但首尾不能含有空格,不能以_sys_开头。 value String 功能说明:标签的值。 取值范围:0-255个字符,支持任意语种字母、数字、空格和_.:/=+-@。 表7 PageInfo 名称 类型 描述 next_marker String 下一页的marker,值为上一次查询响应中最后一个资源的创建时间。 current_count Integer 当前列表中资源数量。
  • URI GET /v5/{project_id}/p2c-vpn-gateways 表1 参数说明 名称 类型 是否必选 描述 project_id String 是 项目ID,可以通过获取项目ID获取项目ID。 表2 请求Query参数列表 名称 类型 是否必选 描述 limit Integer 否 分页查询时每页返回的记录数量。 marker String 否 功能说明:查询本页的起始标记位,为空时为查询第一页。查询下一页的marker可以根据上一页响应的page_info对象中的next_marker填写。 约束:必须与limit一起使用。
  • 响应消息 响应参数 返回状态码为 201: successful operation。 表4 响应Body参数列表 名称 类型 描述 certificate VpnGatewayCertificateConfig object VPN网关证书对象。 request_id String 请求ID。 表5 VpnGatewayCertificateConfig 名称 类型 描述 id String 功能说明:VPN网关证书ID。 格式:36位UUID。 name String 功能说明:VPN网关证书名称。 取值范围:3-63个字符、支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)。 vgw_id String 功能说明:VPN网关ID。 格式:36位UUID。 issuer String 功能说明:国密签名证书颁发者。 取值范围:1-256个字符。 signature_algorithm String 功能说明:国密签名证书签名算法。 取值范围:1-64个字符。 certificate_serial_number String 功能说明:国密签名证书序列号。 取值范围:1-64个字符。 certificate_subject String 功能说明:签名证书使用者。 取值范围:1-256个字符。 certificate_expire_time String 功能说明:国密签名证书过期时间。 certificate_chain_serial_number String 功能说明:CA证书序列号。 取值范围:1-64个字符。 certificate_chain_subject String 功能说明:CA证书使用者。 取值范围:1-256个字符。 certificate_chain_expire_time String 功能说明:CA证书过期时间。 enc_certificate_serial_number String 功能说明:国密加密证书序列号。 取值范围:1-64个字符。 enc_certificate_subject String 功能说明:加密证书使用者。 取值范围:1-256个字符。 enc_certificate_expire_time String 功能说明:国密加密证书过期时间。 created_at String 功能说明:创建时间。 响应样例 { "certificate": { "id": "73f072d8-demo-a8df-va86-2a755d95636f", "name": "cert-dce7", "vgw_id": "c7f1d3e3-0476-4a71-95a7-3ce8cbb969de", "issuer": "C=CN,ST=Beijing,L=HaiDian,O=GMCert.org,CN=GMCert GM Root CA - 01", "signature_algorithm": "SM3WITHSM2", "certificate_serial_number": "16548506527294397241", "certificate_subject": "C=CN,ST=beijing,L=beijing,O=huawei,OU=vpn,CN=hwcloud-vpn", "certificate_expire_time": "2024-02-20T15:41:39+08:00", "certificate_chain_serial_number": "12369133709000538078", "certificate_chain_subject": "C=CN,ST=Beijing,L=HaiDian,O=GMCert.org,CN=GMCert GM Root CA - 01", "certificate_chain_expire_time": "2039-07-11T20:31:33+08:00", "enc_certificate_serial_number": "16548506527294397242", "enc_certificate_subject": "C=CN,ST=beijing,L=beijing,O=huawei,OU=vpn,CN=hwcloud-vpn", "enc_certificate_expire_time": "2024-02-20T15:43:26+08:00", "created_at": "2023-03-30T10:47:16.657+08:00" } }
  • 请求消息 请求参数 表2 CreateVpnGatewayCertificateRequestBody 名称 类型 是否必选 描述 certificate CreateVpnGatewayCertificateRequestBodyContent object 是 VPN网关证书对象。 表3 CreateVpnGatewayCertificateRequestBodyContent 名称 类型 是否必选 描述 name String 否 功能说明:VPN网关证书名称。 取值范围:3-63个字符、支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)、.(英文句点)。 默认值:不填时会自动生成格式为vpngw-****的名称。例如:cert-a45b。 certificate String 是 功能说明:签名证书。 取值范围:1-4096个字符。 必须是国密型非CA证书。 private_key String 是 功能说明:国密签名证书私钥。 取值范围:1-4096个字符。 与签名证书的公钥匹配。 certificate_chain String 是 功能说明:CA证书内容。 取值范围:1-8192个字符。 必须是国密型CA证书。 enc_certificate String 是 功能说明:加密证书。 取值范围:1-4096个字符。 必须是国密型非CA证书。 enc_private_key String 是 功能说明:国密加密证书私钥。 取值范围:1-4096个字符。 与加密证书的公钥匹配。 请求样例 POST https://{Endpoint}/v5/{project_id}/vpn-gateways/certificate { "certificate": { "name": "cert-dce7", "certificate": "-----BEGIN CERTIFICATE-----\n******\n-----END CERTIFICATE-----", "private_key": "-----BEGIN EC PRIVATE KEY-----\n*******\n-----END EC PRIVATE KEY-----", "enc_certificate": "-----BEGIN CERTIFICATE-----\n********\n-----END CERTIFICATE-----", "enc_private_key": "-----BEGIN EC PRIVATE KEY-----\n********\n-----END EC PRIVATE KEY-----", "certificate_chain": "-----BEGIN CERTIFICATE-----\n******\n-----END CERTIFICATE-----" } }
  • VPN网关 权限 对应API接口 授权项(Action) 依赖的授权项 IAM 项目 (Project) 企业项目 (Enterprise Project) 创建VPN网关 POST /v5/{project_id}/vpn-gateways vpn:vpnGateways:create er:instances:list er:instances:get vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:subnets:list vpc:subnets:create vpc:subnets:delete vpc:subNetworkInterfaces:update vpc:publicIps:create vpc:publicIps:delete vpc:publicIps:update vpc:publicIps:get vpc:publicIps:list vpc:ports:create vpc:quotas:list vpc:bandwidths:list vpc:ports:get vpc:ports:delete vpc:routeTables:update vpc:routeTables:get vpc:bandwidths:get √ √ 查询VPN网关 GET /v5/{project_id}/vpn-gateways/{vgw_id} vpn:vpnGateways:get vpc:publicIps:get vpc:publicIps:list vpc:bandwidths:list er:instances:list er:instances:get vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:subnets:list √ √ 查询VPN网关列表 GET /v5/{project_id}/vpn-gateways vpn:vpnGateways:list vpc:publicIps:get vpc:publicIps:list vpc:bandwidths:list er:instances:list er:instances:get vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:subnets:list √ × 更新VPN网关 PUT /v5/{project_id}/vpn-gateways/{vgw_id} vpn:vpnGateways:update er:instances:list er:instances:get vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:subnets:list vpc:subnets:delete vpc:subNetworkInterfaces:update vpc:publicIps:delete vpc:publicIps:update vpc:publicIps:get vpc:publicIps:list vpc:bandwidths:list vpc:ports:get vpc:routeTables:update vpc:routeTables:get √ √ 删除VPN网关 DELETE /v5/{project_id}/vpn-gateways/{vgw_id} vpn:vpnGateways:delete er:instances:list er:instances:get vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:subnets:delete vpc:subNetworkInterfaces:update vpc:publicIps:delete vpc:publicIps:update vpc:publicIps:get vpc:publicIps:list vpc:bandwidths:list vpc:ports:get vpc:routeTables:update vpc:routeTables:get √ √ 查询VPN网关可用区(V5) GET /v5/{project_id}/vpn-gateways/availability-zones vpn:vpnGatewayAvailabilityZone:list - √ × 查询VPN网关可用区(V5.1) GET /v5.1/{project_id}/vpn-gateways/availability-zones vpn:vpnGatewayAvailabilityZone:list - √ × 导入VPN网关证书 POST /v5/{project_id}/vpn-gateways/{vgw_id}/certificate vpn:vpnGateways:importCertificate - √ √ 查询VPN网关证书 GET /v5/{project_id}/vpn-gateways/{vgw_id}/certificate vpn:vpnGateways:getCertificate - √ √ 更新VPN网关证书 PUT /v5/{project_id}/vpn-gateways/{vgw_id}/certificate/{certificate_id} vpn:vpnGateways:updateCertificate - √ √ 父主题: 站点入云VPN授权项列表
  • VPN网关 权限 对应API接口 授权项(Action) 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 订购包周期终端入云VPN网关 POST /v5/{project_id}/p2c-vpn-gateways/subscribe/{order_id} vpn:p2cVpnGateway:subscribe vpn:system:listAvailabilityZones vpc:vpcs:list vpc:subnets:get vpc:bandwidths:list vpc:publicIps:create vpc:publicIps:delete vpc:publicIps:update vpc:publicIps:list vpc:quotas:list √ × 变更包周期 VPN网关规格 PUT /v5/{project_id}/p2c-vpn-gateways/update-specification/{order_id} vpn:p2cVpnGateway:updateSpecification - √ × 更新终端入云VPN网关 PUT /v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id} vpn:p2cVpnGateway:update vpc:publicIps:create vpc:publicIps:delete vpc:publicIps:update vpc:publicIps:get vpc:publicIps:list vpc:bandwidths:list √ × 查询终端入云VPN网关详情 GET /v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id} vpn:p2cVpnGateway:get vpc:publicIps:get √ × 查询终端入云VPN网关列表 GET /v5/{project_id}/p2c-vpn-gateways vpn:p2cVpnGateway:list vpc:publicIps:get √ × 查询终端入云VPN连接列表 GET /v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id}/connections vpn:p2cVpnGateway:listConnections - √ × 断开P2C VPN网关连接 POST /v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id}/connections/{connection_id}/disconnect vpn:p2cVpnGateway:disconnectConnection - √ × 父主题: 终端入云VPN授权项列表
  • 响应消息 响应参数 返回状态码为 200: 查询成功。 表2 响应Body参数列表 名称 类型 描述 vpn_servers Array of ShowServerResponse objects 服务端列表。 total_count integer 总数 page_info PageInfo 分页查询页的信息 request_id String 请求id。 表3 ShowServerResponse 名称 类型 描述 id String 功能说明:VPN服务端 ID。 格式:36位UUID。 p2c_vgw_id String 功能说明:P2C VPN网关ID。 格式:36位UUID。 client_cidr String 功能说明:客户端网段。客户端建立连接时,会从该网段分配一个虚拟IP地址。 格式:"点分十进制/掩码"格式,例如192.168.1.0/24。 local_subnets Array of strings 功能说明:本端网段列表。 格式:"点分十进制/掩码"格式,例如10.10.1.0/24。 client_auth_type String 功能说明:客户端认证类型。 取值范围: CERT:证书认证。 LOCAL_PASSWORD:口令认证(本地)。 tunnel_protocol String 功能说明:隧道协议类型。 取值范围 SSL:SSL协议。 server_certificate server_certificate object 服务端证书。 client_ca_certificates Array of QueryClientCaCertificateBody objects 客户端CA证书列表,用于对客户端证书进行认证。 ssl_options ssl_options object SSL隧道协议的可选配置项。 dns_servers Array of strings 功能说明:DNS服务端列表 格式:"点分十进制"格式,例如172.16.1.1 status String 功能说明:服务端状态。 取值范围: PENDING_CREATE:创建中。 PENDING_UPDATE:更新中。 ACTIVE:正常。 FAULT:异常。 FROZEN:冻结。 created_at String 功能说明:创建时间。 UTC时间格式:yyyy-MM-ddTHH:mm:ssZ。 updated_at String 功能说明:最后更新时间。 UTC时间格式:yyyy-MM-ddTHH:mm:ssZ。 表4 server_certificate 名称 类型 描述 id String 证书ID,为CCM( 云证书管理服务 )中已上传证书的证书ID。若证书在CCM中被删除后,该ID为空。 name String 证书名,为CCM( 云证书管理 服务)中已上传证书的证书名。 issuer String 功能说明:证书颁发者。 取值范围:1-256个字符。 subject String 功能说明:证书使用者。 取值范围:1-256个字符。 serial_number String 功能说明:证书序列号。 取值范围:1-64个字符。 expiration_time String 功能说明:到期时间。 UTC时间格式:yyyy-MM-ddTHH:mm:ssZ。 signature_algorithm String 功能说明:证书签名算法。 取值范围:1-64个字符。 表5 QueryClientCaCertificateBody 名称 类型 描述 id String 功能说明:证书ID。 格式:36位UUID。 name String 功能说明:证书名称。 取值范围:1-64个字符、支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)。 issuer String 功能说明:证书颁发者。 取值范围:1-256个字符。 subject String 功能说明:证书使用者。 取值范围:1-256个字符。 serial_number String 功能说明:CA证书序列号。 取值范围:1-64个字符。 expiration_time String 功能说明:证书到期时间。 UTC时间格式:yyyy-MM-ddTHH:mm:ssZ。 signature_algorithm String 功能说明:证书签名算法。 取值范围:1-64个字符。 created_at String 功能说明:创建时间。 UTC时间格式:yyyy-MM-ddTHH:mm:ssZ。 updated_at String 功能说明:最后更新时间。 UTC时间格式:yyyy-MM-ddTHH:mm:ssZ。 表6 ssl_options 名称 类型 描述 protocol string 功能说明:协议。 取值范围:TCP。 port integer 功能说明:端口。 取值范围: 443 1194 encryption_algorithm string 功能说明:加密算法。 取值范围: AES-128-GCM AES-256-GCM authentication_algorithm string 功能说明:认证算法。 取值范围: SHA256 SHA384 is_compressed boolean 功能说明:是否压缩,默认否。 取值范围: true false 表7 PageInfo 名称 类型 描述 next_marker String 功能说明:下一页的marker,值为上一次查询响应中最后一个资源的创建时间 current_count integer 功能说明:当前列表中资源数量 响应样例 { "vpn_servers": [ { "id": "2407a20d-0bf7-4530-ba9a-7ffa0cedfa3b", "p2c_vgw_id": "3b5b64e4-2927-4062-acf6-05b0b842bbfe", "client_cidr": "1.1.0.0/16", "local_subnets": [ "192.168.12.0/24", "192.168.1.0/24" ], "client_auth_type": "LOCAL_PASSWORD", "tunnel_protocol": "SSL", "server_certificate": { "id": "scs1716171403922", "name": "lsh-newcert", "issuer": "C=CN,ST=beijing,L=haidian,O=lesaas,OU=root,CN=www.***.com", "subject": "C=CN,ST=beijing,L=haidian,O=server,OU=server,CN=www.***.com", "serial_number": "310325804134830162280305057622726926320418980636", "expiration_time": "2024-06-19T02:15:26Z", "signature_algorithm": "SHA256WITHRSA" }, "client_ca_certificates": [], "ssl_options": { "protocol": "TCP", "port": 443, "encryption_algorithm": "AES-128-GCM", "authentication_algorithm": "SHA256", "is_compressed": false }, "status": "ACTIVE", "created_at": "2024-06-14T01:14:56.802Z", "updated_at": "2024-06-14T08:53:22.855Z" } ], "request_id": "3378c265585ffb8aac68ec39a2db67a1" }
  • 请求消息 请求参数 无。 请求样例 查询所有VPN连接。 GET https://{Endpoint}/v5/{project_id}/vpn-connection 指定vgw_ip查询VPN连接。 GET https://{Endpoint}/v5/{project_id}/vpn-connection?vgw_ip={vgw_ip}&limit={limit}&marker={marker} 指定VPN网关实例查询VPN连接。 GET https://{Endpoint}/v5/{project_id}/vpn-connection?vgw_id={vgw_id}&limit={limit}&marker={marker}
  • 响应消息 响应参数 返回状态码为 200: successful operation。 表3 响应Body参数列表 名称 类型 描述 vpn_connections Array of ResponseVpnConnection objects vpn_connection对象。 page_info PageInfo object 分页信息。 request_id String 请求ID。 total_count Long 租户下连接总数。 表4 ResponseVpnConnection 名称 类型 描述 id String 功能说明:VPN连接ID。 格式:36位UUID。 name String 功能说明:VPN连接名称。 取值范围:1-64个字符,支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)、.(点)。 status String 功能说明:VPN连接状态。 取值范围: ERROR:异常。 ACTIVE:正常。 DOWN:未连接。 PENDING_CREATE:创建中。 PENDING_UPDATE:更新中。 PENDING_DELETE:删除中。 FREEZED:冻结中。 UNKNOWN:未知。 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。 enable_hub Boolean 功能说明:开启分支互联。仅当style为BGP时返回。 取值范围: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一致。 connection_monitor_id String 功能说明:VPN连接监控ID。仅当VPN连接下创建有连接监控时返回。 格式:36位UUID。 ha_role String 功能说明:主备模式VPN网关下的连接时,'master'表示主连接,'slave'表示备连接。双活模式下的连接ha_role都是'master'。 默认值:master。 tags Array of VpnResourceTag objects 标签列表。 表5 PolicyRule 名称 类型 描述 source String 源地址网段。 destination Array of String 目的地址网段。单个IPv4网段格式示例:192.168.52.0/24。单个IPv6网段格式示例:16af:cacc:1097::/48。每个PolicyRule最多返回50个。 表6 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,如果未指定则返回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 对等体存活检测对象。 表7 Dpd 名称 类型 描述 timeout Integer 功能说明:对等体存活检测报文重传间隔。 取值范围:2-60,单位:秒。 interval Integer 功能说明:对等体存活检测空闲时间。 取值范围:10-3600,单位:秒。 msg String 功能说明:对等体存活检测报文格式。 取值范围: seq-hash-notify:指定DPD报文中的载荷顺序是hash-notify。 seq-notify-hash:指定DPD报文中的载荷顺序是notify-hash。 表8 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:隧道模式。 表9 VpnResourceTag 名称 类型 描述 key String 功能说明:标签的键。 取值范围:1-128个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。 value String 功能说明:标签的值。 取值范围:0-255个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。 表10 PageInfo 名称 类型 描述 next_marker String 下一页的marker,值为上一次查询响应中最后一个资源的创建时间。 current_count Integer 当前列表中资源数量。若小于查询请求传入的limit则表示最后一页。 响应样例 查询所有VPN连接的响应。 { "vpn_connections": [{ "id": "228a68f0-demo-a8df-va86-a9919a3ea3de", "name": "vpn-56ea", "status": "DOWN", "vgw_id": "ba90819b-demo-a8df-va86-3a01622856a5", "vgw_ip": "3ea3b006-demo-a8df-va86-ae180ae07885", "style": "STATIC", "cgw_id": "537d9c26-demo-a8df-va86-99364a410f00", "peer_subnets": [ "192.168.1.0/24" ], "tunnel_local_address": "169.254.149.2/30", "tunnel_peer_address": "169.254.149.1/30", "enable_nqa": true, "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.1.1.216", "peer_id_type": "ip", "peer_id": "10.0.1.67", "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-12-11T13:59:59.633Z", "updated_at": "2022-12-11T13:59:59.633Z", "enterprise_project_id": "0" }, { "id": "a4df33ca-demo-a8df-va86-410a7dd6973f", "name": "vpn-15ea", "status": "DOWN", "vgw_id": "02217fb1-demo-a8df-va86-806ea291a8f2", "vgw_ip": "f5acac2c-demo-a8df-va86-72b819a5f525", "style": "POLICY", "cgw_id": "10a4496f-demo-a8df-va86-7510f4b2af33", "tunnel_local_address": "169.254.77.169/30", "tunnel_peer_address": "169.254.77.170/30", "policy_rules": [{ "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": 3600, "local_id_type": "ip", "local_id": "88.***.***.167", "peer_id_type": "ip", "peer_id": "10.***.***.21", "dpd": { "interval": 30, "timeout": 15, "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-12-09T07:24:27.674Z", "updated_at": "2022-12-09T07:24:27.674Z", "enterprise_project_id": "0", "ha_role":"master" } ], "page_info": { "next_marker": "2022-12-09T07:24:27.674Z", "current_count": 2 }, "request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac", "total_count": 2 } 指定vgw_ip查询VPN连接的响应。 { "vpn_connections": [ { "id": "8fa335dd-demo-a8df-va86-78bb55a8bb04", "name": "vpn-2acd", "status": "DOWN", "vgw_id": "02217fb1-demo-a8df-va86-806ea291a8f2", "vgw_ip": "f5acac2c-demo-a8df-va86-72b819a5f525", "style": "STATIC", "cgw_id": "eba04567-demo-a8df-va86-5b0352f89af0", "peer_subnets": [ "192.168.44.0/24" ], "tunnel_local_address": "169.254.58.225/30", "tunnel_peer_address": "169.254.58.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": 3600, "local_id_type": "ip", "local_id": "88.***.***.167", "peer_id_type": "ip", "peer_id": "10.***.***.9", "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-12-11T14:24:25.115Z", "updated_at": "2022-12-11T14:24:25.115Z", "enterprise_project_id": "0" }, { "id": "a4df33ca-demo-a8df-va86-410a7dd6973f", "name": "vpn-15ea", "status": "DOWN", "vgw_id": "02217fb1-demo-a8df-va86-806ea291a8f2", "vgw_ip": "f5acac2c-demo-a8df-va86-72b819a5f525", "style": "POLICY", "cgw_id": "10a4496f-demo-a8df-va86-7510f4b2af33", "tunnel_local_address": "169.254.77.169/30", "tunnel_peer_address": "169.254.77.170/30", "policy_rules": [ { "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": 3600, "local_id_type": "ip", "local_id": "88.***.***.167", "peer_id_type": "ip", "peer_id": "10.***.***.21", "dpd": { "interval": 30, "timeout": 15, "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-12-11T13:59:59.633Z", "updated_at": "2022-12-11T13:59:59.633Z", "enterprise_project_id": "0", "ha_role":"master" } ], "page_info": { "next_marker": "2022-12-11T13:59:59.633Z", "current_count": 2 }, "request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac", "total_count": 12 } 指定VPN网关实例查询VPN连接的响应。 { "vpn_connections": [ { "id": "8fa335dd-demo-a8df-va86-78bb55a8bb04", "name": "vpn-2acd", "status": "DOWN", "vgw_id": "02217fb1-demo-a8df-va86-806ea291a8f2", "vgw_ip": "f5acac2c-demo-a8df-va86-72b819a5f525", "style": "STATIC", "cgw_id": "eba04567-demo-a8df-va86-5b0352f89af0", "peer_subnets": [ "192.168.44.0/24" ], "tunnel_local_address": "169.254.58.225/30", "tunnel_peer_address": "169.254.58.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": 3600, "local_id_type": "ip", "local_id": "88.***.***.167", "peer_id_type": "ip", "peer_id": "10.***.***.9", "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-12-11T14:24:25.115Z", "updated_at": "2022-12-11T14:24:25.115Z", "enterprise_project_id": "0", "ha_role":"master" }, { "id": "a4df33ca-demo-a8df-va86-410a7dd6973f", "name": "vpn-15ea", "status": "DOWN", "vgw_id": "02217fb1-demo-a8df-va86-806ea291a8f2", "vgw_ip": "f5acac2c-demo-a8df-va86-72b819a5f525", "style": "POLICY", "cgw_id": "10a4496f-demo-a8df-va86-7510f4b2af33", "tunnel_local_address": "169.254.77.169/30", "tunnel_peer_address": "169.254.77.170/30", "policy_rules": [ { "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": 3600, "local_id_type": "ip", "local_id": "88.***.***.167", "peer_id_type": "ip", "peer_id": "10.***.***.21", "dpd": { "interval": 30, "timeout": 15, "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-12-11T13:59:59.633Z", "updated_at": "2022-12-11T13:59:59.633Z", "enterprise_project_id": "0", "ha_role":"master" } ], "page_info": { "next_marker": "2022-12-11T13:59:59.633Z", "current_count": 2 }, "request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac", "total_count": 12 }
  • URI GET /v5/{project_id}/vpn-connection 表1 参数说明 名称 类型 是否必选 说明 project_id String 是 项目ID,可以通过获取项目ID获取项目ID。 表2 请求Query参数列表 名称 类型 是否必选 描述 vgw_ip String 否 VPN网关EIP的ID或接入私网IP。 vgw_id String 否 VPN网关ID。 enterprise_project_id Array 否 企业项目ID。 limit Integer 否 功能说明:分页查询时每页返回的记录数量。 取值范围:0-200。 默认值:200。 marker String 否 功能说明:查询本页的起始标记位,为空时为查询第一页。查询下一页的marker可以根据上一页响应的page_info对象中的next_marker填写。 约束:必须与limit一起使用。
  • 响应消息 响应参数 返回状态码为 200: 查询成功。 表2 响应Body参数列表 名称 类型 描述 vpn_gateway ResponseVpnGateway object vpn_gateway对象。 request_id String 请求ID。 表3 ResponseVpnGateway 名称 类型 描述 id String 功能说明:VPN网关ID。 格式:36位UUID。 name String 功能说明:VPN网关名称。 取值范围:1-64个字符,支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)、.(点)。 network_type String 功能说明:VPN网关网络类型。 取值范围:public,private。 默认值:public。 status String 功能说明:VPN网关状态。 取值范围: PENDING_CREATE:创建中。 PENDING_UPDATE:更新中。 PENDING_DELETE:删除中。 ACTIVE:正常。 FAULT:异常。 FREEZED:冻结。 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时返回。 er_attachment_id String VPN网关关联的ER连接ID。 vpc_id String VPN网关关联的业务VPC的ID。仅当attachment_type为vpc时返回。 local_subnets Array of String IPv4本端子网。本端子网是云上子网,该网段需要通过VPN与用户侧网络进行互通。单个网段格式示例:192.168.52.0/24。仅当attachment_type为vpc且ip_version为ipv4时返回。 local_subnets_v6 Array of String IPv6本端子网。本端子网是云上子网,该网段需要通过VPN与用户侧网络进行互通。单个网段格式示例:16af:cacc:1097::/48。仅当attachment_type为vpc且ip_version为ipv6时返回。 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时返回。 public_border_group String 公共边界组 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。 applied_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时返回。 certificate_id String 功能说明:VPN网关使用的VPN网关证书ID,仅在flavor为GM时返回。 格式:36位UUID ha_mode String 功能说明:网关的HA模式,"active-active"表示双活,"active-standby"表示主备。 取值范围:active-active,active-standby。 默认值:active-active。 policy_template PolicyTemplate object 非固定IP接入VPN网关网关的策略模板配置,只有在规格为非固定IP接入VPN网关时返回。 supported_flavors Array of String 网关可升配到的目标规格。 supported_features Array of String 网关可支持的特性功能。 tags Array of VpnResourceTag objects 标签列表。 表4 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,如: 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:独享带宽 WHOLE:共享带宽 表5 PolicyTemplate 名称 类型 描述 ike_policy IkePolicy object ike 策略对象。 ipsec_policy IpsecPolicy object ipsec 策略对象。 表6 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,单位:秒。 表7 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,单位:秒。 表8 VpnResourceTag 名称 类型 描述 key String 功能说明:标签的键。 取值范围:1-128个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。 value String 功能说明:标签的值。 取值范围:0-255个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。 响应样例 查询公网类型关联ER的VPN网关。 { "vpn_gateway": { "id": "66ddeacb-demo-a8df-va86-9a414b5bd7d5", "name": "vpngw-5bd6", "network_type": "public", "status": "ACTIVE", "attachment_type": "er", "ip_version": "ipv4", "er_id": "c62fad0d-demo-a8df-va86-e06c4c351b9f", "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": "0f6d1415-demo-a8df-va86-edb2ee97c9cc", "ip_version": 4, "type": "5_bgp", "ip_address": "88.***.***.251", "charge_mode": "bandwidth", "bandwidth_id": "e93767cc-demo-a8df-va86-bac2987f90a4", "bandwidth_size": 300, "bandwidth_name": "vpngw-bandwidth-10c3" }, "eip2": { "id": "7b46b62f-demo-a8df-va86-6b8e44312416", "ip_version": 4, "type": "5_bgp", "ip_address": "88.***.***.102", "charge_mode": "bandwidth", "bandwidth_id": "bde3557e-demo-a8df-va86-629a3754ae07", "bandwidth_size": 300, "bandwidth_name": "vpngw-bandwidth-18bd" }, "created_at": "2022-11-28T02:22:27.24Z", "updated_at": "2022-11-28T02:22:27.24Z", "access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa", "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114", "ha_mode": "active-active" }, "request_id": "28b795f8-d431-4f1e-93ab-1c401a82b799" } 查询私网类型关联VPC的VPN网关。 { "vpn_gateway": { "id": "66ddeacb-demo-a8df-va86-9a414b5bd7d5", "name": "vpngw-5bd6", "network_type": "private", "status": "ACTIVE", "attachment_type": "vpc", "ip_version": "ipv4", "vpc_id": "91a74241-demo-a8df-va86-9b5f98c66c8c", "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"], "availability_zone_ids": ["az1", "az2"], "connection_number": 200, "used_connection_number": 0, "used_connection_group": 0, "enterprise_project_id": "0", "created_at": "2022-11-28T02:22:27.24Z", "updated_at": "2022-11-28T02:22:27.24Z", "access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa", "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114", "access_private_ip_1": "192.168.146.45", "access_private_ip_2": "192.168.146.77", "ha_mode": "active-active" }, "request_id": "28b795f8-d431-4f1e-93ab-1c401a82b799" } 查询公网类型关联VPC的非固定IP接入VPN网关。 { "vpn_gateway":{ "id":"66ddeacb-demo-a8df-va86-9a414b5bd7d5", "name":"vpngw-5bd6", "network_type":"public", "status":"ACTIVE", "attachment_type":"vpc", "ip_version": "ipv4", "vpc_id":"c62fad0d-demo-a8df-va86-e06c4c351b9f", "local_subnets":[ "192.168.0.0/24" ], "connect_subnet":"fd75bf7b-demo-a8df-va86-db13f03e299a", "bgp_asn":64512, "flavor":"Professional1-NonFixedIP", "availability_zone_ids":[ "cn-north-7c" ], "connection_number":200, "used_connection_number":0, "used_connection_group":0, "enterprise_project_id":"0", "ha_mode":"active-standby", "eip1":{ "id":"0f6d1415-demo-a8df-va86-edb2ee97c9cc", "ip_version":4, "type":"5_bgp", "ip_address":"88.***.***.251", "charge_mode":"bandwidth", "bandwidth_id":"e93767cc-demo-a8df-va86-bac2987f90a4", "bandwidth_size":300, "bandwidth_name":"vpngw-bandwidth-10c3" }, "eip2":{ "id":"7b46b62f-demo-a8df-va86-6b8e44312416", "ip_version":4, "type":"5_bgp", "ip_address":"88.***.***.102", "charge_mode":"bandwidth", "bandwidth_id":"bde3557e-demo-a8df-va86-629a3754ae07", "bandwidth_size":300, "bandwidth_name":"vpngw-bandwidth-18bd" }, "policy_template":{ "ike_policy":{ "encryption_algorithm":"aes-128", "dh_group":"group20", "authentication_algorithm":"sha2-256", "lifetime_seconds":86400 }, "ipsec_policy":{ "authentication_algorithm":"sha2-256", "encryption_algorithm":"aes-128", "pfs":"group20", "lifetime_seconds":3600 } }, "created_at":"2022-11-28T02:22:27.24Z", "updated_at":"2022-11-28T02:22:27.24Z", "access_vpc_id":"4d03fe2d--demo-a8df-va86-6def96440f2b", "access_subnet_id":"fd75bf7b--demo-a8df-va86-e-db13f03e299a" }, "request_id":"28b795f8-d431-4f1e-93ab-1c401a82b799" }
  • 返回结果 状态码 请求发送以后,您会收到响应,其中包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于管理员创建IAM用户管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于管理员创建IAM用户管理员创建IAM用户接口,返回如图1所示的消息头。 图1 管理员创建IAM用户响应消息头 响应消息体(可选) 该部分可选。响应消息体通常以结构化格式(如JSON或XML)返回,与响应消息头中Content-Type对应,传递除响应消息头之外的内容。 对于管理员创建IAM用户管理员创建IAM用户接口,返回如下消息体。为篇幅起见,这里只展示部分内容。 { "user": { "id": "c131886aec...", "name": "IAMUser", "description": "IAM User Description", "areacode": "", "phone": "", "email": "***@***.com", "status": null, "enabled": true, "pwd_status": false, "access_mode": "default", "is_domain_owner": false, "xuser_id": "", "xuser_type": "", "password_expires_at": null, "create_time": "2024-05-21T09:03:41.000000", "domain_id": "d78cbac1..........", "xdomain_id": "30086000........", "xdomain_type": "", "default_project_id": null } } 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "error_msg": "Request body is invalid.", "error_code": "IAM.0011" } 其中,error_code表示错误码,error_msg表示错误描述信息。 父主题: 如何调用API
  • 修订记录 表1 修订记录 发布日期 更新说明 2025-04-16 第十次正式发布。文档内容更新为: 修改创建VPN连接、查询VPN连接、批量创建VPN连接章节,修改表“PolicyRule”的描述说明。 2025-02-05 第九次正式发布。文档内容更新为: 修改创建VPN用户、批量创建VPN用户、查询VPN用户、查询VPN用户列表、修改VPN用户、删除VPN用户章节,新增客户端静态IP地址的描述说明。 2024-08-31 第八次正式发布。文档内容更新为: 新增批量创建VPN用户、批量删除VPN用户章节。 2024-08-23 第七次正式发布。文档内容更新为: 新增站点入云VPN授权项列表、终端入云VPN授权项列表、服务公共接口授权项列表章节。 2024-06-30 第六次正式发布。文档内容更新为: 新增终端入云VPN网关、服务端、用户管理、访问策略、VPN配额、VPN标签章节。 新增修改网关规格章节。 2024-04-19 第五次正式发布。文档内容更新为: 修改创建VPN网关章节,“flavor”参数新增VPN网关规格的描述说明。 2023-12-30 第四次正式发布。文档内容更新为: 新增标签章节。 修改创建VPN网关、查询VPN网关、查询VPN网关列表、更新VPN网关、创建对端网关、查询对端网关、查询对端网关列表、更新对端网关、创建VPN连接、查询VPN连接、查询VPN连接列表、更新VPN连接章节,新增“tags”参数。 修改创建VPN网关、查询VPN网关、查询VPN网关列表章节,删除“master_eip”、“slave_eip”参数。 修改更新VPN网关章节,删除“master_eip_id”、“slave_eip_id”参数。 修改查询VPN网关、查询VPN网关列表章节,删除“access_private_ips”参数。 2023-09-30 第三次正式发布。文档内容更新为: 修改查询VPN网关、查询VPN网关列表、更新VPN网关章节,“flavor”参数新增非固定IP接入的VPN网关规格的描述说明。 修改查询VPN网关可用区章节,响应消息中新增“professional1-NonFixedIP”“professional2-NonFixedIP”参数,修改响应样例。 修改查询VPN网关、查询VPN网关列表、更新VPN网关章节,新增非固定IP接入特性的相关描述说明。 2023-07-15 第二次正式发布。文档内容更新为: 新增上传VPN网关证书章节。 新增查询VPN网关证书详情章节。 新增更新VPN网关证书章节。 修改创建VPN网关、查询VPN网关、查询VPN网关列表、更新VPN网关章节,“flavor”参数新增国密特性的描述说明。 修改查询VPN网关、创建对端网关、查询对端网关、查询对端网关列表、更新对端网关章节,新增“certificate_id”参数。 修改查询VPN网关可用区章节,响应消息中新增“GM”参数,修改响应样例。 修改创建VPN连接、查询VPN连接、查询VPN连接列表、更新VPN连接章节,新增国密特性相关的描述说明。 修改创建VPN网关章节,修改“bandwidth_size”参数的描述说明。 修改创建VPN连接章节,修改“dh_group”和“pfs”参数的默认值为“group15”。 修改创建VPN网关、查询VPN网关、查询VPN网关列表、更新VPN网关章节,新增“ha_mode”、“eip1”、“eip2”参数,修改“master_eip”、“slave_eip”参数的描述说明。 修改查询VPN网关、查询VPN网关列表和更新VPN网关章节,新增“access_private_ip_1”、“access_private_ip_2”,修改“access_private_ips”参数的描述说明。 修改创建VPN连接、查询VPN连接、查询VPN连接列表、更新VPN连接章节,新增“ha_role”参数。 2022-12-31 第一次正式发布。 发布日期 修改说明 2025-03-30 第一次正式发布。
  • 响应消息 响应参数 返回状态码为 200: successful operation。 表2 响应Body参数列表 名称 类型 描述 logs Array of Log objects log对象 request_id String 请求ID。 表3 Log 名称 类型 描述 time Integer 功能说明:时间戳。 raw_message String 功能说明:日志信息。 响应样例 { "logs": [ { "time": 1735024112, "raw_message": "2024-12-24T07:08:32.730275+00:00 host-xx-xx-xx-xx ipsec_ike[30085]: [xx.xx.xx.xx] IPSec tunnel negotiation fails. (IfIndex=[207], PolicyName=[], SeqNum=[0], PeerAddress=[xx.xx.xx.xx], PeerPort=[500], Reason=[version mismatch])" } ], "request_id": "f15d2c621593f2018c23eb1d49e3605e" }
  • 请求消息 请求参数 表2 请求参数 名称 类型 必选 描述 vpn_server UpdateServerRequest object 是 更新VPN服务端请求对象。 表3 UpdateServerRequest 名称 类型 必选 描述 client_cidr String 否 功能说明:客户端网段。客户端建立连接时,会从该网段分配一个虚拟IP地址。 格式:"点分十进制/掩码"格式,例如192.168.1.0/24。 约束: 客户端网段不能和网关所在VPC默认路由表中的路由存在冲突。 客户端网段不能和本服务端中本端网段列表的网段存在冲突。 客户端网段地址池的IP地址数量需大于网关最大连接数的四倍。 客户端网段不能使用以下特殊网段:0.0.0.0/8, 127.0.0.0/8, 224.0.0.0/4, 240.0.0.0/4, 169.254.0.0/16。 local_subnets Array of strings 否 功能说明:本端网段列表。本端网段是需要访问的云上的目的网段,该网段需要通过VPN与用户侧网络进行互通。 格式:"点分十进制/掩码"格式,例如10.10.1.0/24。 约束: 至少有一个本端网段,默认最多支持填写20个网段。 本端网段不能使用以下特殊网段:0.0.0.0/8, 127.0.0.0/8, 224.0.0.0/4, 240.0.0.0/4。 server_certificate server_certificate object 否 服务端证书,推荐使用强密码算法的证书,如RSA3072/4096。 ssl_options ssl_options object 否 SSL隧道协议的可选配置项。 client_auth_type String 否 功能说明:客户端认证类型。 取值范围: CERT:证书认证。 LOCAL_PASSWORD:口令认证(本地)。 dns_servers Array of strings 否 功能说明:DNS服务端列表,最多两个DNS 格式:"点分十进制"格式,例如172.16.1.1 表4 server_certificate 名称 类型 必选 描述 id String 是 功能说明:证书ID,为CCM(云证书管理服务)中已上传证书的证书ID。 表5 ssl_options 名称 类型 必选 描述 protocol String 否 功能说明:协议。 取值范围:TCP 默认值:TCP port Integer 否 功能说明:端口号。 取值范围: 443 1194 默认值:443。 encryption_algorithm String 否 功能说明:加密算法。 取值范围: AES-128-GCM AES-256-GCM 默认值:AES-128-GCM。 请求样例 PUT https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id} { "vpn_server": { "client_cidr": "192.168.10.0/24", "local_subnets": [ "172.16.0.0/24", "172.16.1.0/24" ], "server_certificate": { "id": "scs1717051012106" }, "ssl_options": { "protocol": "TCP", "port": 443, "encryption_algorithm": "AES-128-GCM" }, "client_auth_type": "CERT" } }
  • 响应消息 响应参数 返回状态码为200: successful operation。 表4 响应Body参数列表 名称 类型 描述 certificate VpnGatewayCertificateConfig object VPN网关证书对象。 request_id String 请求id。 表5 VpnGatewayCertificateConfig 名称 类型 描述 id String 功能说明:VPN网关证书ID。 格式:36位UUID。 name String 功能说明:VPN网关证书名称。 取值范围:3-63个字符、支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)。 vgw_id String 功能说明:VPN网关ID。 格式:36位UUID。 issuer String 功能说明:国密签名证书颁发者。 取值范围:1-256个字符。 signature_algorithm String 功能说明:国密签名证书签名算法。 取值范围:1-64个字符。 certificate_serial_number String 功能说明:国密签名证书序列号。 取值范围:1-64个字符。 certificate_subject String 功能说明:国密签名证书使用者。 取值范围:1-256个字符。 certificate_expire_time String 国密签名证书过期时间。 certificate_chain_serial_number String 功能说明:国密CA证书序列号。 取值范围:1-64个字符。 certificate_chain_subject String 功能说明:国密CA证书使用者。 取值范围:1-256个字符。 certificate_chain_expire_time String 功能说明:国密CA证书过期时间。 enc_certificate_serial_number String 功能说明:国密加密证书序列号。 取值范围:1-64个字符。 enc_certificate_subject String 功能说明:国密加密证书使用者。 取值范围:1-256个字符。 enc_certificate_expire_time String 功能说明:国密加密证书过期时间。 created_at String 功能说明:创建时间。 响应样例 { "certificate": { "id": "73f072d8-demo-a8df-va86-2a755d95636f", "name": "cert-dce7", "vgw_id": "c7f1d3e3-0476-4a71-95a7-3ce8cbb969de", "issuer": "C=CN,ST=Beijing,L=HaiDian,O=GMCert.org,CN=GMCert GM Root CA - 01", "signature_algorithm": "SM3WITHSM2", "certificate_serial_number": "16548506527294397241", "certificate_subject": "C=CN,ST=beijing,L=beijing,O=huawei,OU=vpn,CN=hwcloud-vpn", "certificate_expire_time": "2024-02-20T15:41:39+08:00", "certificate_chain_serial_number": "12369133709000538078", "certificate_chain_subject": "C=CN,ST=Beijing,L=HaiDian,O=GMCert.org,CN=GMCert GM Root CA - 01", "certificate_chain_expire_time": "2039-07-11T20:31:33+08:00", "enc_certificate_serial_number": "16548506527294397242", "enc_certificate_subject": "C=CN,ST=beijing,L=beijing,O=huawei,OU=vpn,CN=hwcloud-vpn", "enc_certificate_expire_time": "2024-02-20T15:43:26+08:00", "created_at": "2023-03-30T10:47:16.657+08:00" } }
  • 请求消息 请求参数 表2 UpdateVpnGatewayCertificateRequestBody 名称 类型 是否必选 描述 certificate UpdateVpnGatewayCertificateRequestBodyContent object 是 VPN网关证书对象。 表3 UpdateVpnGatewayCertificateRequestBodyContent 名称 类型 是否必选 描述 name String 否 功能说明:VPN网关证书名称。 取值范围:3-63个字符、支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)、.(英文句点)。 certificate String 否 功能说明:国密签名证书内容,如果只更新证书名称可以不传。 取值范围:1-4096个字符。 private_key String 否 功能说明:国密签名证书私钥,如果只更新证书名称可以不传。 取值范围:1-4096个字符。 certificate_chain String 否 功能说明:CA证书内容,如果只更新证书名称可以不传。 取值范围:1-8192个字符。 enc_certificate String 否 功能说明:国密加密证书内容,如果只更新证书名称可以不传。 取值范围:1-4096个字符。 enc_private_key String 否 功能说明:国密加密证书私钥,如果只更新证书名称可以不传。 取值范围:1-4096个字符。 请求样例 POST https://{Endpoint}/v5/{project_id}/vpn-gateways/{vgw_id}/certificate/{certificate_id} { "certificate": { "name": "cert-dce7", "certificate": "-----BEGIN CERTIFICATE-----\n******\n-----END CERTIFICATE-----", "private_key": "-----BEGIN EC PRIVATE KEY-----\n*******\n-----END EC PRIVATE KEY-----", "enc_certificate": "-----BEGIN CERTIFICATE-----\n********\n-----END CERTIFICATE-----", "enc_private_key": "-----BEGIN EC PRIVATE KEY-----\n********\n-----END EC PRIVATE KEY-----", "certificate_chain": "-----BEGIN CERTIFICATE-----\n******\n-----END CERTIFICATE-----" } }
  • 响应消息 响应参数 返回状态码为 201: successful operation。 表5 响应Body参数列表 名称 类型 描述 invalid_users Arrays of InvalidVpnUser Object 无效VPN用户对象列表。如果invalid_users列表不为空,说明本次批量创建用户均失败,请传入正确的请求参数后再重试。 request_id String 请求ID。 表6 InvalidVpnUser 名称 类型 描述 name String 用户名称。 description String 用户描述。 user_group_name String 所属用户组名称。 static_ip String 客户端的静态IP地址。 cause String 原因。 响应样例 批量创建成功响应样例: { "invalid_users": [], "request_id": "b19ba5a0be8f7b7f664b14596f8f35db" } 存在非法用户请求时的响应样例: { "invalid_users": [ { "name": "USER1", "description": "用户描述", "user_group_name": "default", "cause": "Duplicate user name." }, { "name": "USER2", "description": "用户描述", "user_group_name": "default", "cause": "Password length invalid." } ], "request_id": "49b52ed16992baa4650d093b512a59b6" }
  • URI POST /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/users/batch-create 表1 参数说明 名称 类型 是否必选 描述 project_id String 是 项目ID,可以通过获取项目ID获取项目ID。 vpn_server_id String 是 VPN服务端ID。 表2 请求Header参数列表 名称 类型 是否必选 描述 X-Client-Token String 否 功能说明:幂等性标识。 格式:36位UUID。
  • 概述 欢迎使用虚拟专用网络(Virtual Private Network,以下简称VPN)。VPN用于在远端用户和虚拟私有云(Virtual Private Cloud,以下简称VPC)之间建立一条安全加密的公网通信隧道。默认情况下,在虚拟私有云(VPC)中的弹性云服务器无法与用户的数据中心或私有网络进行通信。如果需要将VPC中的弹性云服务器和数据中心或私有网络连通,可以启用VPN功能。VPN服务有站点入云VPN和终端入云VPN。站点入云VPN用于在您的本地网络、数据中心与华为云云上网络之间搭建安全、可靠、高性价比的加密连接通道;终端入云VPN用于在您的办公软件与华为云云上网络之间搭建安全、可靠、高性价比的加密连接通道。
  • 响应消息 响应参数 返回状态码为 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。 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 IPv4本端子网。本端子网是云上子网,该网段需要通过VPN与用户侧网络进行互通。单个网段格式示例:192.168.52.0/24。仅当attachment_type为vpc且ip_version为ipv4时返回。 local_subnets_v6 Array of String IPv6本端子网。本端子网是云上子网,该网段需要通过VPN与用户侧网络进行互通。单个网段格式示例:16af:cacc:1097::/48。仅当attachment_type为vpc且ip_version为ipv6时返回。 connect_subnet String VPN网关所使用的VPC中的一个子网ID。 bgp_asn Long VPN网关的BGP自治域编号。 flavor String 功能说明:VPN网关的规格类型。实际可选范围请参考VPN控制台创建VPN网关页面的Specification选项。 取值范围: v300:最大转发带宽300Mbps。该取值已经废弃,但仍然保留兼容性支持,建议不要使用该取值。 v1g:最大转发带宽1Gbps。该取值已经废弃,但仍然保留兼容性支持,建议不要使用该取值。 Basic:最大转发带宽100Mbps。 Professional1:最大转发带宽300Mbps。 Professional1-NonFixedIP:最大转发带宽300Mbps。 Professional2-NonFixedIP:最大转发带宽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。 policy_template PolicyTemplate object 非固定IP接入VPN网关网关的策略模板配置,只有在规格为非固定IP接入VPN网关时返回。 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,单位:秒。 响应样例 使用已有EIP创建关联VPC的VPN网关的响应。 { "vpn_gateway": { "id": "134f9fb1-demo-a8df-va86-2040a5c13325", "name": "vpngw-9f24", "network_type": "public", "attachment_type": "vpc", "ip_version": "ipv4", "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" } 新建EIP创建关联ER的VPN网关的响应。 { "vpn_gateway": { "id": "80ac167b-demo-a8df-va86-a9a2a23223b8", "name": "vpngw-1234", "network_type": "public", "attachment_type": "er", "ip_version": "ipv4", "er_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", "bgp_asn": 65533, "flavor": "Professional2", "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": "cd71cade-bfbd-410b-b672-4bfe46cfc311" } 创建私网关联VPC的VPN网关的响应。 { "vpn_gateway": { "id": "80ac167b-demo-a8df-va86-a9a2a23223b8", "name": "vpngw-1234", "network_type": "private", "attachment_type": "vpc", "ip_version": "ipv4", "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" }
  • 请求消息 请求参数 表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。 ip_version String 否 功能说明:VPN网关的IP协议版本。 取值范围:ipv4、ipv6。 默认值:ipv4 er_id String 否 功能说明:VPN网关所连接的ER实例的ID。 约束:36位UUID。 当attachment_type配置为"er"时填写,否则不填。 er_id和vpc_id不能同时为空。 可以通过查询企业路由列表查看ER实例的ID。 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列表查询VPC列表查看VPC的ID。 local_subnets Array of String 否 功能说明:IPv4本端子网是云上子网,该子网需要通过VPN与云下对端子网进行互通。 每个VPN网关最多填写50个本端子网,单个子网格式示例:192.168.52.0/24。 约束:当attachment_type配置为"vpc"时、且ip_version配置为"ipv4"时必填,否则不填。 local_subnets_v6 Array of String 否 功能说明:IPv6本端子网是云上子网,该子网需要通过VPN与云下对端子网进行互通。 每个VPN网关最多填写50个本端子网,单个子网格式示例:16af:cacc:1097::/48。 约束:当attachment_type配置为"vpc"时、且ip_version配置为"ipv6"时必填,否则不填。 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选项。 取值范围: Basic Professional1 Professional1-NonFixedIP Professional2-NonFixedIP GM 不同规格类型的特性,请参考站点入云VPN产品规格《虚拟专用网络用户指南》的“产品规格”章节。 华北-乌兰察布一:Basic、Professional1、Professional2、 GM 华南-广州:Basic、Professional1、Professional2 华北-北京四:Basic、Professional1、Professional2 华东-上海一:Basic、Professional1、Professional2 西南-贵阳一:Basic、Professional1、Professional2 中国-香港:Professional1、Professional2 亚太-曼谷:Professional1、Professional2 亚太-新加坡:Professional1、Professional2 亚太-雅加达:Professional1、Professional2 欧洲-都柏林:Professional1、Professional2 中东-阿布扎比-OP5:Professional1、Professional2 拉美-墨西哥城二:Professional1、Professional2 土耳其-伊斯坦布尔:Professional1、Professional2 约束:当network_type为private时不能填写Basic;当attachment_type为er时不能填写Basic。 默认值:Professional1。 availability_zone_ids Array of String 否 功能说明:部署VPN网关的可用区。不填时自动为VPN网关选择可用区。如果需要指定可用区可以通过查询VPN网关可用区查询可用区列表,再根据flavor、attachment_type、ip_version的参数组合确定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列表查看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时不填。 可以通过全量查询弹性公网IP列表查看EIP的ID。 type String 否 功能说明:EIP的类型。 取值范围:0-36个字符。 可查看申请EIP表6中type字段的取值范围。如果对应局点支持5_bgp类型,建议优先选择该类型。 约束:当新创建EIP场景时需要填写,否则不填。 具体约束可查看申请EIP表4中type字段的约束。 charge_mode String 否 功能说明:EIP的带宽计费模式。按流量计费或按带宽计费。 取值范围: bandwidth:按带宽计费。 traffic:按流量计费。 约束:当新创建EIP场景且不绑定共享带宽时需要填写,否则不填。 默认值:bandwidth。 bandwidth_size Integer 否 功能说明:EIP的带宽大小,单位:Mbit/s。每个region能够提供的EIP最大带宽不同,EIP的最大带宽受限于EIP服务,可以使用工单来提高帐户下的EIP的最大带宽。 取值范围:1-1000,具体取值请参考弹性公网服务创建EIP资料。 约束:当新创建EIP场景且不绑定共享带宽时需要填写,否则不填。 flavor为Basic时,取值不能大于100;flavor为Professional1时,取值不能大于300;flavor为GM时,取值不能大于500。 bandwidth_name String 否 功能说明:EIP的带宽名称。 取值范围:1-64个字符,支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)、.(点)。 约束:当新创建EIP场景且不绑定共享带宽时需要填写,否则不填。 默认值:当新创建EIP场景时,不填此字段会自动生成格式为vpngw-bandwidth-****的EIP带宽名称。例如:vpngw-bandwidth-e1fa。 bandwidth_id String 否 功能说明:带宽ID,创建弹性公网IP时可以指定已有的共享带宽。 取值范围:36位UUID。 约束:绑定共享带宽时需要填写,否则不填。 表5 VpnResourceTag 名称 类型 是否必选 描述 key String 是 功能说明:标签的键。 取值范围:1-128个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。 value String 是 功能说明:标签的值。 取值范围:0-255个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。 请求样例 使用已有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" } } } 新建EIP创建关联ER的VPN网关。 POST https://{Endpoint}/v5/{project_id}/vpn-gateways { "vpn_gateway": { "name": "vpngw-1234", "attachment_type": "er", "er_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", "vpc_id": "584a238f-demo-a8df-va86-edca746f6277", "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114", "bgp_asn": 65533, "flavor": "Professional2", "availability_zone_ids": [ "cn-south-1f", "cn-south-1e" "az1", "az2", ], "eip1": { "type": "5_bgp", "charge_mode": "bandwidth", "bandwidth_size": 1000, "bandwidth_name": "vpngw-bandwidth-1391" }, "eip2": { "type": "5_bgp", "charge_mode": "bandwidth", "bandwidth_size": 1000, "bandwidth_name": "vpngw-bandwidth-1392" } } } 创建私网关联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" } }
  • 响应消息 响应参数 返回状态码为 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。 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时,vpc_id是VPN网关的接入VPC的ID。 local_subnets Array of String 本端子网。本端子网是云上子网,该网段需要通过VPN与用户侧网络进行互通。单个网段格式示例:192.168.52.0/24。仅当attachment_type为vpc且ip_version为ipv4时返回。 local_subnets_v6 Array of String IPv6本端子网。本端子网是云上子网,该网段需要通过VPN与用户侧网络进行互通。单个网段格式示例:16af:cacc:1097::/48。仅当attachment_type为vpc且ip_version为ipv6时返回。 connect_subnet String VPN网关所使用的VPC中的一个子网ID。 bgp_asn Long VPN网关的BGP自治域编号。 flavor String 功能说明:VPN网关的规格类型: 取值范围: Basic:最大转发带宽100Mbps。 Professional1:最大转发带宽300Mbps。 Professional1-NonFixedIP:最大转发带宽300Mbps。 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,如: CS22********LIBIV:00301-******-0--0:br-iaas-odin1:0605768a************c006c7e484aa。 type String 功能说明:EIP的类型。 取值范围:可查看申请EIP表6《弹性公网IP接口参考》的“申请弹性公网IP”章节中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:共享带宽。 表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", "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"], "availability_zone_ids": ["az1", "az2"], "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", "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":"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 否 功能说明: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解绑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 } } } }
  • 数据准备 表1 创建VPN连接请求关键参数 参数 说明 取值样例 vgw_id VPN网关ID。 8030f6d6-demo-4d20-a7f8-50a7a826e2f8 vgw_ip1 VPN网关EIP1的ID。 e4d7930f-demo-4cbf-b78a-b004416c7485 vgw_ip2 VPN网关EIP2的ID。 1fb97767-demo-4d8b-83bb-6f878f662005 cgw_id 对端网关ID。 8916effb-demo-42d8-83d7-4517567d3d26 peer_subnets 对端子网。 192.168.44.0/24 psk 预共享密钥。 abcd****
  • 操作步骤 基于关联VPC的VPN网关,创建静态路由模式的VPN连接。 发送“POST https://{endpoint}/v5/{project_id}/vpn-connections/batch-create”,project_id为项目ID。 在Request Header中增加“X-Auth-Token”。 在Request Body中传入参数如下。 { "vpn_connections": [ { "vgw_ip": "e4d7930f-demo-4cbf-b78a-b004416c7485", "cgw_id": "8916effb-demo-42d8-83d7-4517567d3d26", "vgw_id": "8030f6d6-demo-4d20-a7f8-50a7a826e2f8", "peer_subnets": [ "192.168.44.0/24" ], "psk": "abcd****" }, { "vgw_ip": "1fb97767-demo-4d8b-83bb-6f878f662005", "cgw_id": "8916effb-demo-42d8-83d7-4517567d3d26", "vgw_id": "8030f6d6-demo-4d20-a7f8-50a7a826e2f8", "peer_subnets": [ "192.168.44.0/24" ], "psk": "abcd****" } ] } 查看请求响应结果。 请求成功时,响应参数如下,id就是VPN连接的ID。 { "vpn_connections": [ { "id": "18be2aa1-demo-410f-832e-4d8ba13b4c5d", "name": "vpn-22b6", "vgw_id": "8030f6d6-demo-4d20-a7f8-50a7a826e2f8", "vgw_ip": "e4d7930f-demo-4cbf-b78a-b004416c7485", "style": "STATIC", "cgw_id": "8916effb-demo-42d8-83d7-4517567d3d26", "peer_subnets": [ "192.168.44.0/24" ], "tunnel_local_address": "169.254.135.49/30", "tunnel_peer_address": "169.254.135.50/30", "enable_nqa": false, "policy_rules": [], "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.***.***.128", "peer_id_type": "ip", "peer_id": "188.***.***.189", "dpd": { "interval": 30, "timeout": 15, "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": "2025-03-17T12:25:21.369Z", "updated_at": "2025-03-17T12:25:21.369Z", "enterprise_project_id": "0", "ha_role": "master", "tags": [], "policy_rules_v6": [] }, { "id": "c7e617bd-877f-demo-8af0-44b5f8598116", "name": "vpn-e41c", "vgw_id": "8030f6d6-demo-4d20-a7f8-50a7a826e2f8", "vgw_ip": "1fb97767-demo-4d8b-83bb-6f878f662005", "style": "STATIC", "cgw_id": "8916effb-demo-42d8-83d7-4517567d3d26", "peer_subnets": [ "192.168.44.0/24" ], "tunnel_local_address": "169.254.73.253/30", "tunnel_peer_address": "169.254.73.254/30", "enable_nqa": false, "policy_rules": [], "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": "215.***.***.55", "peer_id_type": "ip", "peer_id": "188.***.***.189", "dpd": { "interval": 30, "timeout": 15, "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": "2025-03-17T12:25:21.678Z", "updated_at": "2025-03-17T12:25:21.678Z", "enterprise_project_id": "0", "ha_role": "master", "tags": [], "policy_rules_v6": [] } ], "request_id": "a923f31456941e12c5fc9a663a6e630e" } 查询VPN连接详情。 发送“GET https://{endpoint}/v5/{project_id}/vpn-connection/{vpn_connection_id}”,project_id为项目ID。 在Request Header中增加“X-Auth-Token”。 查看请求响应结果。 请求成功时,响应参数如下,id就是VPN连接的ID。 { "vpn_connection": { "id": "98c5af8a-demo-a8df-va86-ae2280a6f4c3", "name": "vpn-1655", "status": "DOWN", "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", }, "request_id": "104c5608-b68b-462c-af17-ead2fb5ccee4" } { "vpn_connection": { "id": "18be2aa1-demo-410f-832e-4d8ba13b4c5d", "name": "vpn-22b6", "status": "DOWN", "vgw_id": "8030f6d6-demo-4d20-a7f8-50a7a826e2f8", "vgw_ip": "e4d7930f-demo-4cbf-b78a-b004416c7485", "style": "STATIC", "cgw_id": "8916effb-demo-42d8-83d7-4517567d3d26", "peer_subnets": [ "192.168.44.0/24" ], "tunnel_local_address": "169.254.135.49/30", "tunnel_peer_address": "169.254.135.50/30", "enable_nqa": false, "policy_rules": [], "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.***.***.128", "peer_id_type": "ip", "peer_id": "188.***.***.189", "dpd": { "interval": 30, "timeout": 15, "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": "2025-03-17T12:25:21.369Z", "updated_at": "2025-03-17T12:25:21.369Z", "enterprise_project_id": "0", "ha_role": "master", "tags": [], "policy_rules_v6": [], "eip_id": "e4d7930f-7038-4cbf-b78a-b004416c7485", "type": "ROUTE", "route_mode": "STATIC" }, "request_id": "62dc155a7353037f0a1ccc569016a3e9" }
  • VPN连接 权限 对应API接口 授权项(Action) 依赖的授权项 IAM项目(Project) 企业项目(Enterprise Project) 创建VPN连接 POST /v5/{project_id}/vpn-connection vpn:vpnConnections:create ces:metricData:list ces:currentRegionSupportedMetrics:list vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:subnets:list vpc:subNetworkInterfaces:update vpc:publicIps:get vpc:publicIps:list vpc:bandwidths:list vpc:ports:get vpc:routeTables:update vpc:routeTables:get √ √ 查询VPN连接列表 GET /v5/{project_id}/vpn-connection vpn:vpnConnections:list vpc:publicIps:get vpc:publicIps:list vpc:bandwidths:list er:instances:list er:instances:get vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:subnets:list √ × 查询VPN连接详情 GET /v5/{project_id}/vpn-connection/{vpn_connection_id} vpn:vpnConnections:get vpc:publicIps:get vpc:publicIps:list vpc:bandwidths:list er:instances:list er:instances:get vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:subnets:list √ √ 更新VPN连接 PUT /v5/{project_id}/vpn-connection/{vpn_connection_id} vpn:vpnConnections:update vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:subnets:list vpc:subNetworkInterfaces:update vpc:publicIps:get vpc:publicIps:list vpc:bandwidths:list vpc:ports:get vpc:routeTables:update vpc:routeTables:get √ √ 删除VPN连接 DELETE /v5/{project_id}/vpn-connection/{vpn_connection_id} vpn:vpnConnections:delete ces:metricData:list ces:currentRegionSupportedMetrics:list vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:subNetworkInterfaces:update vpc:publicIps:get vpc:publicIps:list vpc:bandwidths:list vpc:ports:get vpc:routeTables:update vpc:routeTables:get √ √ 批量创建VPN连接 POST /v5/{project_id}/vpn-connections/batch-create vpn:vpnConnections:batchCreate ces:metricData:list ces:currentRegionSupportedMetrics:list vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:subnets:list vpc:subNetworkInterfaces:update vpc:publicIps:get vpc:publicIps:list vpc:bandwidths:list vpc:ports:get vpc:routeTables:update vpc:routeTables:get √ √ 父主题: 站点入云VPN授权项列表
  • 响应消息 响应参数 返回状态码为 200: successful operation。 表2 响应Body参数列表 名称 类型 描述 vpn_connection ResponseVpnConnection object vpn_connection对象。 request_id String 请求ID。 表3 ResponseVpnConnection 名称 类型 描述 id String 功能说明:VPN连接ID。 格式:36位UUID。 name String 功能说明:VPN连接名称。 取值范围:1-64个字符,支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)、.(点)。 status String 功能说明:VPN连接状态。 取值范围: ERROR:异常。 ACTIVE:正常。 DOWN:未连接。 PENDING_CREATE:创建中。 PENDING_UPDATE:更新中。 PENDING_DELETE:删除中。 FREEZED:冻结中。 UNKNOWN:未知。 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。 enable_hub Boolean 功能说明:开启分支互联。仅当style为BGP时返回。 取值范围: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一致。 connection_monitor_id String 功能说明:VPN连接监控ID。仅当VPN连接下创建有连接监控时返回。 格式:36位UUID。 ha_role String 功能说明:主备模式VPN网关下的连接时,'master'表示主连接,'slave'表示备连接。双活模式下的连接ha_role都是'master'。 默认值:master tags Array of VpnResourceTag objects 标签列表。 bgp_peer BgpPeer object BGP邻居信息。 表4 PolicyRule 名称 类型 描述 source String 源地址网段。 destination Array of String 目的地址网段。单个IPv4网段格式示例:192.168.52.0/24。每个PolicyRule最多返回50个。 表5 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,如果未指定则返回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 对等体存活检测对象。 表6 Dpd 名称 类型 描述 timeout Integer 功能说明:对等体存活检测报文重传间隔。 取值范围:2-60,单位:秒。 interval Integer 功能说明:对等体存活检测空闲时间。 取值范围:10-3600,单位:秒。 msg String 功能说明:对等体存活检测报文格式。 取值范围: seq-hash-notify:指定DPD报文中的载荷顺序是hash-notify。 seq-notify-hash:指定DPD报文中的载荷顺序是notify-hash。 表7 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:隧道模式。 表8 VpnResourceTag 名称 类型 描述 key String 功能说明:标签的键。 取值范围:1-128个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。 value String 功能说明:标签的值。 取值范围:0-255个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。 表9 BgpPeer 名称 类型 描述 peer_ip_address String BGP邻居地址。 peer_asn Integer BGP邻居的BGP自治域编号。 state String 邻居状态。 state_duration String 连接持续时间。 num_received_routes Integer 已收到的路由数。 num_message_received Integer 已收到的消息数。 num_message_sent Integer 已发送的消息数。 响应样例 { "vpn_connection": { "id": "98c5af8a-demo-a8df-va86-ae2280a6f4c3", "name": "vpn-1655", "status": "DOWN", "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.0.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.0.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", "tags": [], "policy_rules_v6": [], "bgp_peer": { "peer_ip_address": "169.254.173.1", "peer_asn": 64516, "state": "established", "state_duration": "3d01h34m24s", "num_received_routes": 5, "num_message_received": 15541, "num_message_sent": 15516 }, }, "request_id": "f91082d4-6d49-479c-ad1d-4e552a9f5cae" }
共100000条
提示

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