华为云计算 云知识 更新VPN网关UpdateVgw
更新VPN网关UpdateVgw

 

功能介绍

根据VPN网关ID,更新指定的VPN网关

URI

PUT /v5/{project_id}/vpn-gateways/{vgw_id}

表1 参数说明

名称

类型

是否必选

说明

project_id

String

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

vgw_id

String

VPN网关实例ID

请求消息

  • 请求参数
    表2 请求参数

    名称

    类型

    是否必选

    描述

    vpn_gateway

    UpdateVgwRequestBodyContent object

    vpn_gateway对象

    表3 UpdateVgwRequestBodyContent

    名称

    类型

    是否必选

    描述

    name

    String

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

    local_subnets

    Array of String

    • 功能说明:本端子网。本端子网是云上子网,该网段需要通过VPN与用户侧网络进行互通。单个网段格式示例:192.168.52.0/24。
    • 约束:当attachment_type配置为"vpc"时可填写,否则不填。每个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时可填写,否则不填。
  • 请求样例
    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-****-****-****-bb7de91cf493",
            "eip_id_2": "6ad8e297-****-****-****-da0f885ccb98"
        }
    }

响应消息

  • 响应参数

    返回状态码为 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

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

    connect_subnet

    String

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

    bgp_asn

    Long

    VPN网关的BGP自治域编号

    flavor

    String

    • 功能说明:VPN网关的规格类型:
    • 取值范围:

      Basic:最大转发带宽100Mbps

      Professional1:最大转发带宽300Mbps

      Professional2:最大转发带宽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。

    master_eip

    ResponseEip object

    • 功能说明:VPN网关使用的第一个EIP
    • 约束:network_type为public时必选,为private时不需要填写
      说明:

      不推荐使用该字段,推荐使用eip1

    eip1

    ResponseEip object

    双活VPN网关表示使用的第一个EIP,主备VPN网关表示主EIP。在VPN网关的状态为ACTIVE时返回。

    slave_eip

    ResponseEip object

    • 功能说明:VPN网关使用的第二个EIP
    • 约束:network_type为public时必选,为private时不需要填写
      说明:

      不推荐使用该字段,推荐使用eip2

    eip2

    ResponseEip object

    双活VPN网关表示使用的第二个EIP,主备VPN网关表示备EIP。在VPN网关的状态为ACTIVE时返回。

    created_at

    String

    创建时间。在VPN网关的状态为ACTIVE时返回。

    updated_at

    String

    最后一次更新时间。在VPN网关的状态为ACTIVE时返回。

    access_vpc_id

    String

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

    access_subnet_id

    String

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

    access_private_ips

    Array of String

    私网类型VPN网关的接入私网IP列表,VPN网关使用该私网IP与对端网关建连。固定返回两个ip地址

    示例:192.168.52.9。仅当network_type为private时返回

    说明:

    不推荐使用,推荐使用access_private_ip_1和access_private_ip_2

    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
    表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,如:

      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。

  • 响应样例
    1. 更新VPN网关的响应
    {
        "vpn_gateway": {
            "id": "620d99b8-****-****-****-200b868f2d7d",
            "name": "vpngw-4321",
            "attachment_type": "vpc",
            "network_type": "public",
            "vpc_id": "cb4a631d-****-****-****-ca3fa348c36c",
            "local_subnets": [
                "192.168.0.0/24"
            ],
            "connect_subnet": "f5741286-****-****-****-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-****-****-****-bb7de91cf493",
                "ip_version": 4,
                "type": "5_bgp",
                "ip_address": "88.***.***.102",
                "charge_mode": "bandwidth",
                "bandwidth_id": "cff40e5e-****-****-****-7366077bf097",
                "bandwidth_size": 300,
                "bandwidth_name": "vpngw-bandwidth-1391"
            },
            "eip2": {
                "id": "6ad8e297-****-****-****-da0f885ccb98",
                "ip_version": 4,
                "type": "5_bgp",
                "ip_address": "88.***.***.188",
                "charge_mode": "bandwidth",
                "bandwidth_id": "d290f1ee-****-****-****-d701748f0851",
                "bandwidth_size": 300,
                "bandwidth_name": "vpngw-bandwidth-1392"
            },
    	"create_time": "2022-09-15T08:56:09.386Z",
            "update_time": "2022-09-15T11:13:13.677Z",
            "access_vpc_id": "0cf79a3f-****-****-****-d7ace626b0fa",
            "access_subnet_id": "f5741286-****-****-****-2c82bd9ee114",
            "ha_mode": "active-active"
        },
        "request_id": "33a2b77a-65f9-4fa0-90bd-4bd42038eb41"
    }

    2. VPN状态为“创建中”,更新失败

    {
        "error_code":"VPN.0003",
        "error_msg":"resource (type=GATEWAY, ID=ff9bdca6-****-****-****-e4bcc1ea52bc) is not ready,
    currently CREATING", "request_id": "abafe41c-7744-41af-bf3d-4452872af799" }

状态码

请参见状态码

 

上一篇:蜂巢计划,整合生态伙伴共同服务中小企业组织 下一篇:为什么全公司就你在加班?我找到了问题所在!

虚拟专用网络 VPN  

虚拟专用网络(Virtual Private Network)用于搭建用户本地数据中心与华为云VPC之间便捷、灵活,即开即用的IPsec加密连接通道,实现灵活一体,可伸缩的混合云计算环境。