華為云計算 云知識 查詢VPN連接監(jiān)控列表ListConnectionMonitors
查詢VPN連接監(jiān)控列表ListConnectionMonitors

 

功能介紹

查詢VPN連接監(jiān)控列表。

URI

GET /v5/{project_id}/connection-monitors

表1 參數(shù)說明

名稱

類型

是否必選

說明

project_id

String

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

表2 請求Query參數(shù)列表

名稱

類型

是否必選

描述

vpn_connection_id

String

VPN連接Id

enterprise_project_id

Array

企業(yè)項目ID

請求消息

  • 請求參數(shù)

  • 請求樣例
    1.查詢所有VPN連接監(jiān)控。
    GET https://{Endpoint}/v5/{project_id}/connection-monitors
    2.根據(jù)vpn_connection_id查詢VPN連接監(jiān)控。
    GET https://{Endpoint}/v5/{project_id}/connection-monitors?vpn_connection_id={vpn_connection_id}

響應(yīng)消息

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

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

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

    名稱

    類型

    描述

    connection_monitors

    Array of ConnectionMonitorInfo objects

    connection_monitor對象

    request_id

    String

    請求ID

    表4 ConnectionMonitorInfo

    名稱

    類型

    描述

    id

    String

    • 功能說明:VPN連接監(jiān)控ID
    • 格式:36位UUID

    status

    String

    • 功能說明:VPN連接監(jiān)控狀態(tài)
    • 取值范圍:

      ACTIVE:正常

      PENDING_CREATE:創(chuàng)建中

      PENDING_DELETE:刪除中

    vpn_connection_id

    String

    • 功能說明:VPN連接監(jiān)控對應(yīng)的VPN連接ID
    • 格式:36位UUID

    type

    String

    • 功能說明:監(jiān)控類型
    • 取值范圍:gateway

    source_ip

    String

    VPN連接監(jiān)控的源地址

    destination_ip

    String

    VPN連接監(jiān)控的目的地址

    proto_type

    String

    • 功能說明:nqa使用的協(xié)議類型
    • 取值范圍:icmp
  • 響應(yīng)樣例
    1. 查詢所有VPN連接監(jiān)控的響應(yīng)
      {
          "connection_monitors":[
              {
                  "id":"76f64229-****-****-****-3907e2815b6d",
                  "status":"ACTIVE",
                  "vpn_connection_id":"2342adf2-****-****-****-12aq511s0917",
                  "type":"gateway",
                  "source_ip":"88.***.***.60",
                  "destination_ip":"88.***.***.32",
                  "proto_type":"icmp"
              },
              {
                  "id":"85t53318-****-****-****-zq9312525f6t",
                  "status":"ACTIVE",
                  "vpn_connection_id":"cae286f2-****-****-****-e22416ca1220",
                  "type":"gateway",
                  "source_ip":"89.***.***.21",
                  "destination_ip":"88.***.***.12",
                  "proto_type":"icmp"
              }
          ],
          "request_id": "531f8b2c-ec55-45d8-90a3-ede922f7d63c"
      }
    2. 根據(jù)vpn_connection_id查詢VPN連接監(jiān)控的響應(yīng)
      {
          "connection_monitors":[
              {
                  "id":"76f64229-****-****-****-3907e2815b6d",
                  "status":"ACTIVE",
                  "vpn_connection_id":"2342adf2-****-****-****-12aq511s0917",
                  "type":"gateway",
                  "source_ip":"88.***.***.60",
                  "destination_ip":"88.***.***.32",
                  "proto_type":"icmp"
              }
          ],
          "request_id": "05ab9b58-9b4c-4cee-8113-4b0f325f1dfc"
      }

狀態(tài)碼

請參見狀態(tài)碼