虚拟专用网络 VPN-创建VPN网关:响应消息

时间:2024-12-25 09:52:04

响应消息

  • 响应参数

    返回状态码为 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,单位:秒。
  • 响应样例
    1. 使用已有EIP创建关联VPC的VPN网关的响应。
      {
          "vpn_gateway": {
              "id": "134f9fb1-demo-a8df-va86-2040a5c13325",
              "name": "vpngw-9f24",
              "network_type": "public",
              "attachment_type": "vpc",
              "vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa",
              "local_subnets": ["192.168.0.0/24"],
              "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114",
              "bgp_asn": 64512,
              "flavor": "Professional1",
              "connection_number": 200,
              "used_connection_number": 0,
              "used_connection_group": 0,
              "enterprise_project_id": "0",
              "access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa",
              "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114",
              "ha_mode": "active-active"
          },
          "request_id": "7b37532a-d6e4-46b9-98dc-9169ec2ca58f"
      }
    2. 新建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"
      }
    3. 创建私网关联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"
      }
support.huaweicloud.com/api-vpn/vpn_api_0014.html