華為云計算 云知識 更新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"
        }
    }

響應消息

  • 響應參數

    返回狀態(tài)碼為 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

    • 功能說明:關聯(lián)模式
    • 取值范圍:vpc,er

    er_id

    String

    VPN網關所連接的ER實例的ID。僅當attachment_type為er時返回。

    vpc_id

    String

    當attachment_type為vpc時,vpc_id是VPN網關關聯(lián)的業(yè)務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網關的規(guī)格類型:
    • 取值范圍:

      Basic:最大轉發(fā)帶寬100Mbps

      Professional1:最大轉發(fā)帶寬300Mbps

      Professional2:最大轉發(fā)帶寬1Gbps

      GM:最大轉發(fā)帶寬500Mbps

    availability_zone_ids

    Array of String

    部署VPN網關的可用區(qū)。當指定了可用區(qū)時則返回;當未指定可用區(qū)時,在VPN網關的狀態(tài)為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

    • 功能說明:企業(yè)項目ID
    • 格式:36位UUID。創(chuàng)建時不傳則返回"0",表示資源屬于default企業(yè)項目。

      注:"0"并不是真實存在的企業(yè)項目ID。

    master_eip

    ResponseEip object

    • 功能說明:VPN網關使用的第一個EIP
    • 約束:network_type為public時必選,為private時不需要填寫
      說明:

      不推薦使用該字段,推薦使用eip1

    eip1

    ResponseEip object

    雙活VPN網關表示使用的第一個EIP,主備VPN網關表示主EIP。在VPN網關的狀態(tài)為ACTIVE時返回。

    slave_eip

    ResponseEip object

    • 功能說明:VPN網關使用的第二個EIP
    • 約束:network_type為public時必選,為private時不需要填寫
      說明:

      不推薦使用該字段,推薦使用eip2

    eip2

    ResponseEip object

    雙活VPN網關表示使用的第二個EIP,主備VPN網關表示備EIP。在VPN網關的狀態(tài)為ACTIVE時返回。

    created_at

    String

    創(chuàng)建時間。在VPN網關的狀態(tài)為ACTIVE時返回。

    updated_at

    String

    最后一次更新時間。在VPN網關的狀態(tài)為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。當使用默認企業(yè)項目時返回"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,具體取值請參考彈性公網服務創(chuàng)建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狀態(tài)為“創(chuàng)建中”,更新失敗

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

狀態(tài)碼

請參見狀態(tài)碼