華為云計算 云知識 查詢VPN網(wǎng)關(guān)ShowVgw
查詢VPN網(wǎng)關(guān)ShowVgw

 

功能介紹

根據(jù)VPN網(wǎng)關(guān)ID,查詢指定的VPN網(wǎng)關(guān)

URI

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

表1 參數(shù)說明

名稱

類型

是否必選

說明

project_id

String

項目ID,可以通過獲取項目ID獲取項目ID

vgw_id

String

VPN網(wǎng)關(guān)ID

請求消息

  • 請求參數(shù)

  • 請求樣例
    GET https://{Endpoint}/v5/{project_id}/vpn-gateways/{vgw_id}

響應(yīng)消息

  • 響應(yīng)參數(shù)

    返回狀態(tài)碼為 200: 查詢成功

    表2 響應(yīng)Body參數(shù)列表

    名稱

    類型

    描述

    vpn_gateway

    ResponseVpnGateway object

    vpn_gateway對象

    request_id

    String

    請求ID

    表3 ResponseVpnGateway

    名稱

    類型

    描述

    id

    String

    • 功能說明:VPN網(wǎng)關(guān)ID
    • 格式:36位UUID

    name

    String

    • 功能說明:VPN網(wǎng)關(guān)名稱,不填時會自動生成
    • 取值范圍:1-64個字符,包括數(shù)字、英文字母、中文(\u4e00 - \u9fa5)、_(下劃線)、-(中劃線)。

    network_type

    String

    • 功能說明:VPN網(wǎng)關(guān)網(wǎng)絡(luò)類型
    • 取值范圍:public,private。
    • 默認(rèn)值:public

    status

    String

    • 功能說明:VPN網(wǎng)關(guān)狀態(tài)
    • 取值范圍:

      PENDING_CREATE:創(chuàng)建中

      PENDING_UPDATE:更新中

      PENDING_DELETE:刪除中

      ACTIVE:正常

      FAULT:異常

      FREEZED:凍結(jié)

    attachment_type

    String

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

    er_id

    String

    VPN網(wǎng)關(guān)所連接的ER實例的ID。僅當(dāng)attachment_type為er時返回

    vpc_id

    String

    當(dāng)attachment_type為vpc時,vpc_id是VPN網(wǎng)關(guān)關(guān)聯(lián)的業(yè)務(wù)VPC的ID。

    當(dāng)attachment_type為er時,vpc_id是VPN網(wǎng)關(guān)的接入VPC的ID。

    local_subnets

    Array of String

    本端子網(wǎng)。本端子網(wǎng)是云上子網(wǎng),該網(wǎng)段需要通過VPN與用戶側(cè)網(wǎng)絡(luò)進(jìn)行互通。單個網(wǎng)段格式示例:192.168.52.0/24。僅當(dāng)attachment_type為vpc時返回。

    connect_subnet

    String

    VPN網(wǎng)關(guān)所使用的VPC中的一個子網(wǎng)ID

    bgp_asn

    Long

    VPN網(wǎng)關(guān)的BGP自治域編號

    flavor

    String

    • 功能說明:VPN網(wǎng)關(guān)的規(guī)格類型:
    • 取值范圍:

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

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

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

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

    availability_zone_ids

    Array of String

    部署VPN網(wǎng)關(guān)的可用區(qū)。當(dāng)指定了可用區(qū)時則返回;當(dāng)未指定可用區(qū)時,在VPN網(wǎng)關(guān)的狀態(tài)為ACTIVE時返回。

    connection_number

    Integer

    VPN網(wǎng)關(guān)下的最大VPN連接數(shù)

    used_connection_number

    Integer

    VPN網(wǎng)關(guān)下當(dāng)前已經(jīng)使用的VPN連接數(shù)

    used_connection_group

    Integer

    VPN網(wǎng)關(guān)下當(dāng)前已經(jīng)使用的VPN連接組個數(shù)。同一用戶網(wǎng)關(guān)入云的兩條連接組成一個連接組。VPN網(wǎng)關(guān)默認(rèn)支持10個免費的VPN連接組。

    enterprise_project_id

    String

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

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

    master_eip

    ResponseEip object

    • 功能說明:VPN網(wǎng)關(guān)使用的第一個EIP
    • 約束:network_type為public時必選,為private時不需要填寫
      說明:

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

    eip1

    ResponseEip object

    雙活VPN網(wǎng)關(guān)表示使用的第一個EIP,主備模式VPN網(wǎng)關(guān)表示主EIP。在VPN網(wǎng)關(guān)的狀態(tài)為ACTIVE時返回。

    slave_eip

    ResponseEip object

    • 功能說明:VPN網(wǎng)關(guān)使用的第二個EIP
    • 約束:network_type為public時必選,為private時不需要填寫
      說明:

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

    eip2

    ResponseEip object

    雙活VPN網(wǎng)關(guān)表示使用的第二個EIP,主備模式VPN網(wǎng)關(guān)表示備EIP。在VPN網(wǎng)關(guān)的狀態(tài)為ACTIVE時返回。

    created_at

    String

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

    updated_at

    String

    最后一次更新時間。在VPN網(wǎng)關(guān)的狀態(tài)為ACTIVE時返回。

    access_vpc_id

    String

    • 功能說明:VPN網(wǎng)關(guān)使用的接入VPC ID
    • 格式:36位UUID

    access_subnet_id

    String

    • 功能說明:VPN網(wǎng)關(guān)使用的接入VPC中的子網(wǎng)ID
    • 格式:36位UUID

    access_private_ips

    Array of String

    私網(wǎng)類型VPN網(wǎng)關(guān)的接入私網(wǎng)IP列表,VPN網(wǎng)關(guān)使用該私網(wǎng)IP與對端網(wǎng)關(guān)建連。固定返回兩個 ip地址 。

    示例:192.168.52.9。僅當(dāng)network_type為private時返回。

    說明:

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

    access_private_ip_1

    String

    私網(wǎng)類型VPN網(wǎng)關(guān)的接入私網(wǎng)IP,VPN網(wǎng)關(guān)使用該私網(wǎng)IP與對端網(wǎng)關(guān)建連。雙活網(wǎng)關(guān)表示使用的第一個私網(wǎng)地址,主備表示主私網(wǎng)地址。

    示例:192.168.52.9。僅當(dāng)network_type為private時返回。

    access_private_ip_2

    String

    私網(wǎng)類型VPN網(wǎng)關(guān)的接入私網(wǎng)IP,VPN網(wǎng)關(guān)使用該私網(wǎng)IP與對端網(wǎng)關(guān)建連。雙活網(wǎng)關(guān)表示使用的第二個私網(wǎng)地址,主備表示備私網(wǎng)地址。

    示例:192.168.52.9。僅當(dāng)network_type為private時返回。

    certificate_id

    String

    • 功能說明:VPN網(wǎng)關(guān)使用的VPN網(wǎng)關(guān)證書ID,僅在flavor為GM時返回。
    • 格式:36位UUID

    ha_mode

    String

    • 功能說明:網(wǎng)關(guān)的HA模式,"active-active"表示雙活,"active-standby"表示主備
    • 取值范圍:active-active,active-standby
    • 默認(rèn)值:active-active
    表4 ResponseEip

    名稱

    類型

    描述

    id

    String

    • 功能說明:EIP的ID
    • 格式:36位UUID。當(dāng)使用默認(rèn)企業(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的 公網(wǎng)IP v4地址
    • 格式: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服務(wù),可以使用工單來提高賬戶下的EIP的最大帶寬。
    • 取值范圍:1-1000

    bandwidth_name

    String

    • 功能說明:EIP的帶寬名稱
    • 取值范圍:1-64個字符,支持?jǐn)?shù)字、英文字母、中文(\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。

  • 公網(wǎng)類型關(guān)聯(lián)ER的VPN網(wǎng)關(guān)的響應(yīng)樣例
    {
        "vpn_gateway": {
            "id": "66ddeacb-****-****-****-9a414b5bd7d5",
            "name": "vpngw-5bd6",
            "network_type": "public",
            "status": "ACTIVE",
            "attachment_type": "er",
            "er_id": "c62fad0d-****-****-****-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-****-****-****-edb2ee97c9cc",
                "ip_version": 4,
                "type": "5_bgp",
                "ip_address": "88.***.***.251",
                "charge_mode": "bandwidth",
                "bandwidth_id": "e93767cc-****-****-****-bac2987f90a4",
                "bandwidth_size": 300,
                "bandwidth_name": "vpngw-bandwidth-10c3"
            },
            "eip2": {
                "id": "7b46b62f-****-****-****-6b8e44312416",
                "ip_version": 4,
                "type": "5_bgp",
                "ip_address": "88.***.***.102",
                "charge_mode": "bandwidth",
                "bandwidth_id": "bde3557e-****-****-****-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-****-****-****-d7ace626b0fa",
            "access_subnet_id": "f5741286-****-****-****-2c82bd9ee114",
            "ha_mode": "active-active"
        },
        "request_id": "28b795f8-d431-4f1e-93ab-1c401a82b799"
    }
  • 私網(wǎng)類型關(guān)聯(lián)VPC的VPN網(wǎng)關(guān)的響應(yīng)樣例
    {
        "vpn_gateway": {
            "id": "66ddeacb-****-****-****-9a414b5bd7d5",
            "name": "vpngw-5bd6",
            "network_type": "private",
            "status": "ACTIVE",
            "attachment_type": "vpc",
            "vpc_id": "91a74241-****-****-****-9b5f98c66c8c",
            "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",
            "created_at": "2022-11-28T02:22:27.24Z",
            "updated_at": "2022-11-28T02:22:27.24Z",
            "access_vpc_id": "0cf79a3f-****-****-****-d7ace626b0fa",
            "access_subnet_id": "f5741286-****-****-****-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"
    }

狀態(tài)碼

請參見狀態(tài)碼