云服务器内容精选

  • 响应消息 响应参数 返回状态码为 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。 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 标签列表。 表4 PolicyRule 名称 类型 描述 rule_index Integer 功能说明:规则ID。 取值范围:0-50。 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连接所使用的网关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时返回对端网关的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个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。 响应样例 { "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" }, "request_id": "f91082d4-6d49-479c-ad1d-4e552a9f5cae" }
  • 响应消息 响应参数 返回状态码为 200: 更新成功。 表5 响应Body参数列表 名称 类型 描述 customer_gateway ResponseCustomerGateway object customer_gateway对象。 request_id String 请求id。 表6 ResponseCustomerGateway 名称 类型 描述 id String 功能说明:对端网关的ID。 格式:36位UUID。 name String 功能说明:对端网关名称。 取值范围:1-64个字符,包括数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)。 id_type String 功能说明:对端网关标识类型。 取值范围: ip。 fqdn。 id_value String 对端网关标识值。 bgp_asn Long 对端网关的BGP自治域编号。仅当id_type为ip时返回。 created_at String 创建时间。 UTC时间格式:yyyy-MM-ddTHH:mm:ss.SSSZ。 updated_at String 最后一次更新时间。 UTC时间格式:yyyy-MM-ddTHH:mm:ss.SSSZ。 ca_certificate CaCertificate object 对端网关CA证书信息。仅当对端网关绑定CA证书时返回。 tags Array of VpnResourceTag objects 标签列表。 表7 CaCertificate 名称 类型 描述 id String 证书ID。 serial_number String 证书序列号。 signature_algorithm String 签名算法。 issuer String 证书颁发者。 subject String 证书使用者。 expire_time String 证书过期时间。 is_updatable boolean 是否能更新证书内容。 表8 VpnResourceTag 名称 类型 描述 key String 功能说明:标签的键。 取值范围:1-128个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。 value String 功能说明:标签的值。 取值范围:0-255个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。 响应样例 { "customer_gateway": { "id": "03c0aa3d-demo-a8df-va86-9d82473765d4", "name": "cgw-f846", "id_type": "ip", "id_value": "10.***.***.21", "bgp_asn": 65533, "ca_certificate": { "serial_number": "14257156674311863338", "signature_algorithm": "SM3WITHSM2", "issuer": "C=CN,O=a0002,CN=XXX", "subject": "C=CN,O=a0002,CN=XXX", "expire_time": "2024-05-22T07:34:22Z", "is_updatable": true }, "created_at": "2021-12-21T16:49:28.108Z", "updated_at": "2021-12-21T16:49:28.108Z" }, "request_id": "96718f4a-f57a-4e1f-8d05-7d5e903c8d90" }
  • 请求消息 请求参数 表2 请求参数 名称 类型 是否必选 描述 customer_gateway UpdateCgwRequestBodyContent object 是 customer_gateway对象。 表3 UpdateCgwRequestBodyContent 名称 类型 是否必选 描述 name String 否 功能说明:网关名称。 取值范围:1-64个字符,支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)、.(点)。 ca_certificate CaCertificateRequest object 否 功能说明:对端网关CA证书。 表4 CaCertificateRequest 名称 类型 是否必选 描述 id String 否 功能说明:证书ID。 格式:36位UUID。 content String 否 功能说明:对端网关CA证书内容。 取值范围:1-8192个字符。 请求样例 PUT https://{Endpoint}/v5/{project_id}/customer-gateways/{customer_gateway_id} { "customer_gateway": { "name": "cgw-f846", "ca_certificate": { "content":"******" } } }
  • 响应消息 响应参数 返回状态码为 200: successful operation。 表4 响应Body参数列表 名称 类型 描述 vpn_gateway ResponseVpnGateway object vpn_gateway对象。 request_id String 请求ID。 表5 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时返回。 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时返回。 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 标签列表。 表6 ResponseEip 名称 类型 描述 id String 功能说明:EIP的ID。 格式:36位UUID。当使用默认企业项目时返回"0"。 ip_version Integer 功能说明:EIP版本。 取值范围:4。 ip_billing_info String 功能说明:EIP的订单信息。包年/包月EIP才会返回订单信息,按需计费的EIP不返回。 格式:order_id:product_id:region_id:project_id,如: CS 22********LIBIV:00301-******-0--0:br-iaas-odin1:0605768a************c006c7e484aa。 type String 功能说明:EIP的类型。 取值范围:可查看申请EIP表6中type字段的取值范围。 ip_address String 功能说明:EIP的公网IPv4地址。 格式:ipv4类型地址。例如:88.***.***.11。 charge_mode String 功能说明:EIP的带宽计费模式。按流量计费或按带宽计费。 取值范围: bandwidth:按带宽计费。 traffic:按流量计费。 bandwidth_id String 功能说明:EIP的带宽ID。 格式:36位UUID。 bandwidth_size Integer 功能说明:EIP的带宽大小,单位:Mbit/s。每个region能够提供的EIP最大带宽不同,EIP的最大带宽受限于EIP服务,可以使用工单来提高帐户下的EIP的最大带宽。 取值范围:1-1000,具体取值请参考弹性公网服务创建eip资料。 bandwidth_name String 功能说明:EIP的带宽名称。 取值范围:1-64个字符,支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)、.(点)。 bandwidth_billing_info String 功能说明:EIP的带宽订单信息。包年/包月EIP带宽才会返回带宽订单信息,按需计费的EIP带宽不返回。 格式:order_id:product_id:region_id:project_id,如: CS22********LIBIV:00301-******-0--0:br-iaas-odin1:0605768a************c006c7e484aa。 share_type String 功能说明: 带宽共享类型。 取值范围: PER:独享带宽。 WHOLE:共享带宽。 表7 PolicyTemplate 名称 类型 描述 ike_policy IkePolicy object ike策略对象。 ipsec_policy IpsecPolicy object ipsec策略对象。 表8 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,单位:秒。 表9 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,单位:秒。 表10 VpnResourceTag 名称 类型 描述 key String 功能说明:标签的键。 取值范围:1-128个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。 value String 功能说明:标签的值。 取值范围:0-255个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。
  • 请求消息 请求参数 表2 请求参数 名称 类型 是否必选 描述 vpn_gateway UpdateVgwSpecificationRequestBodyContent object 是 vpn_gateway对象 表3 UpdateVgwSpecificationRequestBodyContent 名称 类型 是否必选 描述 flavor String 是 功能说明:更新后的VPN网关规格 取值范围:Basic,Professional1,Professional2,Professional1-NonFixedIP,Professional2-NonFixedIP。 每个网关支持的取值范围参考查询VPN网关响应中的supported_flavors字段 请求样例 POST https://{Endpoint}/v5/{project_id}/vpn-gateways/{vgw_id}/update-specification { "vpn_gateway": { "flavor": "Basic" } }
  • 响应消息 响应参数 返回状态码为 200: successful operation。 表2 响应Body参数列表 名称 类型 描述 availability_zones AvailabilityZones object 可用区列表。 request_id String 请求ID。 表3 AvailabilityZones 名称 类型 描述 basic VpnGatewayAvailabilityZones object Basic网关规格。 professional1 VpnGatewayAvailabilityZones object Professional1网关规格。 Professional1-NonFixedIP VpnGatewayAvailabilityZones object Professional1-NonFixedIP网关规格。 professional2 VpnGatewayAvailabilityZones object Professional2网关规格。 Professional2-NonFixedIP VpnGatewayAvailabilityZones object Professional2-NonFixedIP网关规格。 gm VpnGatewayAvailabilityZones object GM网关规格。 以上网关规格的实际可选范围请参考VPN控制台创建VPN网关页面的Specification选项。 表4 VpnGatewayAvailabilityZones 名称 类型 描述 vpc Array of String 关联VPC类型的可用区列表。 er Array of String 关联ER类型的可用区列表。 响应样例 { "availability_zones": { "basic": { "vpc": ["cn-south-1f"], "er": [] }, "professional1": { "vpc": ["cn-south-1f", "cn-south-1e", "cn-south-1c"], "er": ["cn-south-1f"] }, "professional2": { "vpc": ["cn-south-1f", "cn-south-1e", "cn-south-1c"], "er": ["cn-south-1f"] }, "Professional1-NonFixedIP": { "vpc": [], "er": [] }, "Professional2-NonFixedIP": { "vpc": [], "er": [] }, "gm": { "vpc": ["cn-south-1f", "cn-south-1e", "cn-south-1c"], "er": ["cn-south-1f"] } }, "request_id": "b60309ab-812c-4269-9de4-fb9a65e6db16" }
  • API概览 虚拟专用网络 提供的接口参见表1,各接口对应的权限说明请参见权限策略和授权项。 表1 VPN接口说明 类型 说明 站点入云VPN API VPN网关 站点入云VPN网关的创建、查询、更新、删除以及查询站点入云VPN网关可用区等接口。 对端网关 对端网关的创建、查询、更新、删除等接口。 VPN连接 VPN连接的创建、查询、更新、删除等接口。 VPN连接监控 VPN连接健康检查的创建、查询、删除等接口。 终端入云VPN API VPN网关 终端入云VPN网关的查询、修改、终端入云VPN网关可用区的查询以及终端入云网关连接信息列表的查询等接口。 服务端 服务端的创建、查询、修改和导出客户端配置,以及客户端CA证书的导入、查询、修改和删除等接口。 用户管理 VPN用户的创建、查询、修改、删除、修改密码和重置密码,以及VPN用户组的创建、批量创建、查询、修改、删除、批量删除、添加VPN用户到组、删除组内VPN用户和查询组内VPN用户等接口。 访问策略 VPN访问策略的创建、查询、修改和删除接口。 服务公共接口 VPN配额 配额查询接口。 VPN标签 标签查询、添加和删除等接口。
  • 响应消息 响应参数 返回状态码为 200: successful operation。 表8 响应Body参数列表 名称 类型 描述 vpn_connection ResponseVpnConnection object vpn_connection对象。 request_id String 请求ID。 表9 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 object 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 标签列表。 表10 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个。 表11 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连接所使用的网关IP;当local_id_type为fqdn时返回创建或更新VPN连接时指定的本端ID。 当VPN网关flavor为GM时不返回。 peer_id_type String 功能说明:对端ID类型,当VPN网关flavor为GM时不返回。 取值范围: ip。 any。 fqdn。 peer_id String 对端ID。当peer_id_type为ip时返回对端网关的IP;当peer_id_type为fqdn时返回创建或更新VPN连接时指定的对端ID;当peer_id_type为any时不返回。 当VPN网关flavor为GM时不返回。 dpd Dpd object 对等体存活检测对象。 表12 Dpd 名称 类型 描述 timeout Integer 功能说明:对等体存活检测报文重传间隔。 取值范围:2-60,单位:秒。 interval Integer 功能说明:对等体存活检测空闲时间。 取值范围:10-3600,单位:秒。 msg String 功能说明:对等体存活检测报文格式。 取值范围: seq-hash-notify:指定DPD报文中的载荷顺序是hash-notify。 seq-notify-hash:指定DPD报文中的载荷顺序是notify-hash。 表13 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密钥组 取值范围:group1,group2,group5,group14,group15,group16,group19,group20,group21,disable。 transform_protocol String 功能说明:传输协议。 取值范围: esp:封装安全协议。 lifetime_seconds Integer 功能说明:表示配置IPSec连接建立的隧道以时间为基准的生存周期。 取值范围:30-604800,单位:秒。 encapsulation_mode String 功能说明:报文封装模式。 取值范围: tunnel:隧道模式。 表14 VpnResourceTag 名称 类型 描述 key String 功能说明:标签的键。 取值范围:1-128个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。 value String 功能说明:标签的值。 取值范围:0-255个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。 响应样例 更新VPN连接的响应。 { "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": "POLICY", "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d", "peer_subnets": ["192.168.1.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.1.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" } 冻结场景下更新失败。 { "error_code": "VPN.0001", "error_msg": "invalid request: ILLEGAL not allowed update vpnConnection", "request_id": "8c833634-4560-7897-7740-a7462f5bcbd4" }
  • 响应消息 响应参数 返回状态码为 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:最大转发带宽1Gbps。 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", "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", "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的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 Professional2 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的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为Professional2时,取值不能大于1000;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" ], "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" } }
  • 响应消息 响应参数 返回状态码为 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连接所使用的网关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时返回对端网关的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: 查询成功。 表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时返回。 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时返回。 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时返回。 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 网关可升配到的目标规格。 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_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。 表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"], "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" }
  • 前提条件 已创建 DLI 队列。创建队列详见创建DLI队列操作指导。 队列的计费类型必须为:“包年/包月”,“按需计费”(按需计费需勾选“专属资源模式”。) 仅“包年/包月”资源、“专属资源模式”的“按需计费”资源才能创建增强型跨源链接。 已创建对应的外部数据源集群。具体对接的外部数据源根据业务自行选择。 表1 创建各外部数据源参考 服务名 参考文档链接 RDS RDS MySQL快速入门。 DWS 创建DWS集群 DMS Kafka 创建Kafka实例 注意: 创建DMS Kafka实例时,不能开启Kafka SASL_SSL。 CSS 创建CSS集群 MRS 创建MRS集群 绑定跨源的DLI队列网段和其他数据源子网网段不能重合。 系统default队列不支持创建跨源连接。
  • 计费方式 计费项 计费方式 描述 参考文档 基础服务计费 流量计费 按照每小时实际使用的流量进行计费,也可以购买流量包抵扣使用的流量。 流量计费 预付费流量包 峰值带宽计费 按照每日峰值带宽进行计费,系统每5分钟统计1个峰值带宽,每日得到288个值,取其中的最大值作为计费带宽。 峰值带宽计费 月结95峰值带宽计费 在一个自然月内,将每个有效日的所有峰值带宽的统计点进行排序,去掉数值最高的5%的统计点,取剩下的数值最高统计点为计费点,再根据合同约定的单价计费。 月结95峰值带宽计费 日峰值月平均计费 在一个自然月内,对所有有效日的最大峰值带宽求和取平均,获得当月的计费带宽,再根据合同约定的单价计费。 日峰值月平均计费 预付费流量包 购买相应加速区域的流量包进行抵扣。优先扣除流量包里的流量,超出部分采用按流量计费方式结算。 预付费流量包 增值服务计费 全站加速请求数 全站加速的动态请求数和静态请求数计费。 增值服务计费 服务概览和统计分析页面展示的是加速 域名 日志中记录的流量数据,是应用层日志统计出的流量,但是实际产生的网络流量由于TCP/IP包头消耗和TCP重传消耗要比应用层统计到的流量高出7%~15%。因此按照业界标准,应用于账单的计费数据会在控制台监控数据的基础上上浮10%。 流量计费或峰值带宽计费转为月结95峰值带宽计费、日峰值月平均计费方式的商务可当月生效。月结95峰值带宽计费、日峰值月平均计费方式商务发生变更的次月1日生效,当月仍按照变更前的商务执行。 CDN计费分中国大陆、中国大陆境外区域,各区域单独计费,不同区域流量包不能相互抵扣。 CDN支持中国大陆境外分区计费,区域划分请参见中国大陆境外计费区域划分,可提交工单申请开通。
  • 中国大陆境外计费区域划分 计费大区 国家及地区(以华为内部业务划分区域) 亚太1 中国香港、中国澳门、中国台湾、日本、韩国 亚太2 印度 亚太3 越南、印尼、泰国、菲律宾、新加坡、马来西亚、柬埔寨、老挝、吉尔吉斯斯坦、文莱、缅甸、尼泊尔、孟加拉、蒙古、斯里兰卡、哈萨克斯坦、乌兹别克斯坦 欧洲 英国、德国、法国、荷兰、西班牙、意大利、 爱尔兰、瑞典、比利时、奥地利、波兰、罗马尼亚、白俄罗斯、葡萄牙、土耳其、摩尔多瓦、保加利亚、拉脱维亚、瑞士、捷克、匈牙利、卢森堡、希腊、克罗地亚、塞尔维亚、芬兰 中东&非洲 阿联酋、沙特、巴基斯坦、卡塔尔、阿曼、科威特、巴林、伊拉克、南非、埃及、肯尼亚、坦桑尼亚、马达加斯加、吉布提、毛里求斯、加纳、安哥拉、尼日利亚、约旦、也门、以色列、格鲁吉亚、亚美尼亚、塞浦路斯、阿塞拜疆 北美洲 美国、加拿大 大洋洲 澳大利亚、新西兰、斐济 南美洲 巴西、智利、阿根廷、秘鲁、哥伦比亚、厄瓜多尔、墨西哥