更新时间:2024-01-26 GMT+08:00
分享

查询VPN连接列表

功能介绍

查询VPN连接列表。

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/vpn-connection

表1 参数说明

名称

类型

是否必选

说明

project_id

String

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

表2 请求Query参数列表

名称

类型

是否必选

描述

vgw_ip

String

VPN网关EIP的ID或接入私网IP

vgw_id

String

VPN网关ID

enterprise_project_id

Array

企业项目ID

limit

Integer

  • 功能说明:分页查询时每页返回的记录数量
  • 取值范围:0-200
  • 默认值:200

marker

String

  • 功能说明:查询本页的起始标记位,为空时为查询第一页。查询下一页的marker可以根据上一页响应的page_info对象中的next_marker填写。
  • 约束:必须与limit一起使用。

请求消息

  • 请求参数

  • 请求样例
    1. 查询所有VPN连接。
      GET https://{Endpoint}/v5/{project_id}/vpn-connection
    2. 指定vgw_ip查询VPN连接。
      GET https://{Endpoint}/v5/{project_id}/vpn-connection?vgw_ip={vgw_ip}&limit={limit}&marker={marker}
    3. 指定VPN网关实例查询VPN连接。
      GET https://{Endpoint}/v5/{project_id}/vpn-connection?vgw_id={vgw_id}&limit={limit}&marker={marker}

响应消息

  • 响应参数

    返回状态码为 200: successful operation

    表3 响应Body参数列表

    名称

    类型

    描述

    vpn_connections

    Array of

    ResponseVpnConnection objects

    vpn_connection对象

    page_info

    PageInfo object

    分页信息

    request_id

    String

    请求ID

    total_count

    Long

    租户下连接总数

    表4 ResponseVpnConnection

    名称

    类型

    描述

    id

    String

    • 功能说明:VPN连接ID
    • 格式:36位UUID

    name

    String

    • 功能说明:VPN连接名称,不填时会自动生成
    • 取值范围:1-64个字符,支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)、.(点)。

    status

    String

    • 功能说明:VPN连接状态
    • 取值范围:

      ERROR:异常

      ACTIVE:正常

      DOWN:未连接

      PENDING_CREATE:创建中

      PENDING_UPDATE:更新中

      PENDING_DELETE:删除中

      FREEZED:冻结中

      UNKNOWN:未知

    vgw_id

    String

    • 功能说明:VPN网关ID
    • 格式:36位UUID

    vgw_ip

    String

    • 功能说明: VPN网关EIP的ID或接入私网IP
    • 格式:36位UUID或点分十进制IPv4地址(如192.168.45.7)

    style

    String

    • 功能说明:连接模式
    • 取值范围:

      POLICY: 策略模式

      STATIC: 静态路由模式

      BGP: bgp路由模式

      POLICY-TEMPLATE: 策略模板模式

    cgw_id

    String

    • 功能说明:对端网关ID
    • 格式:36位UUID

    peer_subnets

    Array of String

    对端子网。当VPN网关的关联模式为ER并且style字段为BGP或POLICY时不返回。

    tunnel_local_address

    String

    路由模式下配置在VPN网关上的tunnel接口地址。仅当style为STATIC或BGP时有效。

    tunnel_peer_address

    String

    路由模式下配置在用户侧设备上的tunnel接口地址。仅当style为STATIC或BGP时有效。

    enable_nqa

    Boolean

    • 功能说明:开启NQA检测。仅当style为STATIC时返回。
    • 取值范围:true,false。

    policy_rules

    Array of PolicyRule objects

    策略模式的策略规则组。仅当style为POLICY时返回实际的策略规则组

    ikepolicy

    IkePolicy object

    ike策略对象

    ipsecpolicy

    IpsecPolicy object

    ipsec策略对象

    created_at

    String

    创建时间

    updated_at

    String

    最后一次更新时间

    enterprise_project_id

    String

    • 功能说明:企业项目ID
    • 格式:36位UUID。与vgw_id所标识VPN网关的企业项目ID一致。

    connection_monitor_id

    String

    • 功能说明:VPN连接监控ID
    • 格式:36位UUID

    ha_role

    String

    • 功能说明:主备模式VPN网关下的连接时,'master'表示主连接,'slave'表示备连接。双活模式下的连接ha_role都是'master'。
    • 默认值:master

    tags

    Array of VpnResourceTag objects

    标签列表

    表5 PolicyRule

    名称

    类型

    描述

    rule_index

    Integer

    • 功能说明:规则ID
    • 取值范围:0-50

    source

    String

    源地址网段

    destination

    Array of String

    目的地址网段。单个网段格式示例:192.168.52.0/24。每个PolicyRule最多返回50个。

    表6 IkePolicy

    名称

    类型

    描述

    ike_version

    String

    • 功能说明:IKE版本号
    • 取值范围:v1, v2。

    phase1_negotiation_mode

    String

    • 功能说明:协商模式。仅当IKE版本为v1时返回
    • 取值范围:

      main:主模式,协商过程安全性高。

      aggressive:野蛮模式,协商快速且协商成功率高。

    authentication_algorithm

    String

    • 功能说明:认证算法
    • 取值范围:sha2-512,sha2-384,sha2-256,sha1,md5,sm3。

    encryption_algorithm

    String

    • 功能说明:加密算法
    • 取值范围:aes-256-gcm-16,aes-128-gcm-16,aes-256,aes-192,aes-128,3des,sm4。

    dh_group

    String

    • 功能说明:第一阶段密钥交换使用的DH组,当VPN网关flavor为GM时不返回。
    • 取值范围:group1,group2,group5,group14,group15,group16,group19,group20,group21。

    authentication_method

    String

    • 功能说明:ike协商时的认证方法
    • 取值范围:

      pre-share:预共享密钥

    lifetime_seconds

    Integer

    • 功能说明:表示SA的生存周期,当该生存周期超时后IKE SA将自动更新。
    • 取值范围:60-604800,单位:秒

    local_id_type

    String

    • 功能说明:本端ID类型,当VPN网关flavor为GM时不返回。
    • 取值范围:ip,fqdn。

    local_id

    String

    本端ID。当local_id_type为ip时返回VPN连接所使用的网关IP;当local_id_type为fqdn时返回创建或更新VPN连接时指定的本端ID。

    当VPN网关flavor为GM时不返回。

    peer_id_type

    String

    • 功能说明:对端ID类型,当VPN网关flavor为GM时不返回。
    • 取值范围:ip,fqdn。

    peer_id

    String

    对端ID。当peer_id_type为ip时返回对端网关的IP;当peer_id_type为fqdn时返回创建或更新VPN连接时指定的对端ID。

    当VPN网关flavor为GM时不返回。

    dpd

    Dpd object

    对等体存活检测对象

    表7 Dpd

    名称

    类型

    描述

    timeout

    Integer

    • 功能说明:对等体存活检测报文重传间隔
    • 取值范围:2-60,单位:秒。

    interval

    Integer

    • 功能说明:对等体存活检测空闲时间
    • 取值范围:10-3600,单位:秒。

    msg

    String

    • 功能说明:对等体存活检测报文格式
    • 取值范围:

      seq-hash-notify:指定DPD报文中的载荷顺序是hash-notify。

      seq-notify-hash:指定DPD报文中的载荷顺序是notify-hash。

    表8 IpsecPolicy

    名称

    类型

    描述

    authentication_algorithm

    String

    • 功能说明:认证算法
    • 取值范围:sha2-512,sha2-384,sha2-256,sha1,md5,sm3。

    encryption_algorithm

    String

    • 功能说明:加密算法
    • 取值范围:aes-256-gcm-16,aes-128-gcm-16,aes-256,aes-192,aes-128,3des,sm4。

    pfs

    String

    • 功能说明:PFS使用的DH密钥组,当VPN网关flavor为GM时不返回。
    • 取值范围:group1,group2,group5,group14,group15,group16,group19,group20,group21,disable。

    transform_protocol

    String

    • 功能说明:传输协议
    • 取值范围:

      esp:封装安全协议

    lifetime_seconds

    Integer

    • 功能说明:表示配置IPSec连接建立的隧道以时间为基准的生存周期。
    • 取值范围:30-604800,单位:秒。

    encapsulation_mode

    String

    • 功能说明:报文封装模式
    • 取值范围:

      tunnel:隧道模式

    表9 VpnResourceTag

    名称

    类型

    描述

    key

    String

    • 功能说明:标签的键
    • 取值范围:1-128个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@

    value

    String

    • 功能说明:标签的值
    • 取值范围:0-255个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@
    表10 PageInfo

    名称

    类型

    描述

    next_marker

    String

    下一页的marker,值为上一次查询响应中最后一个资源的创建时间。

    current_count

    Integer

    当前列表中资源数量。若小于查询请求传入的limit则表示最后一页。

  • 响应样例
    1. 查询所有VPN连接的响应。
      {
          "vpn_connections": [{
                  "id": "228a68f0-****-****-****-a9919a3ea3de",
                  "name": "vpn-56ea",
                  "status": "DOWN",
                  "vgw_id": "ba90819b-****-****-****-3a01622856a5",
                  "vgw_ip": "3ea3b006-****-****-****-ae180ae07885",
                  "style": "STATIC",
                  "cgw_id": "537d9c26-****-****-****-99364a410f00",
                  "peer_subnets": [
                      "192.168.1.0/24"
                  ],
                  "tunnel_local_address": "169.254.149.2/30",
                  "tunnel_peer_address": "169.254.149.1/30",
                  "enable_nqa": true,
                  "ikepolicy": {
                      "ike_version": "v2",
                      "authentication_algorithm": "sha2-256",
                      "encryption_algorithm": "aes-128",
                      "dh_group": "group15",
                      "authentication_method": "pre-share",
                      "lifetime_seconds": 86400,
                      "local_id_type": "ip",
                      "local_id": "10.1.1.216",
                      "peer_id_type": "ip",
                      "peer_id": "10.0.1.67",
                      "dpd": {
                          "timeout": 15,
                          "interval": 30,
                          "msg": "seq-hash-notify"
                      }
                  },
                  "ipsecpolicy": {
                      "authentication_algorithm": "sha2-256",
                      "encryption_algorithm": "aes-128",
                      "pfs": "group15",
                      "transform_protocol": "esp",
                      "lifetime_seconds": 3600,
                      "encapsulation_mode": "tunnel"
                  },
                  "created_at": "2022-12-11T13:59:59.633Z",
                  "updated_at": "2022-12-11T13:59:59.633Z",
                  "enterprise_project_id": "0"
              },
              {
                  "id": "a4df33ca-****-****-****-410a7dd6973f",
                  "name": "vpn-15ea",
                  "status": "DOWN",
                  "vgw_id": "02217fb1-****-****-****-806ea291a8f2",
                  "vgw_ip": "f5acac2c-****-****-****-72b819a5f525",
                  "style": "POLICY",
                  "cgw_id": "10a4496f-****-****-****-7510f4b2af33",
                  "tunnel_local_address": "169.254.77.169/30",
                  "tunnel_peer_address": "169.254.77.170/30",
                  "policy_rules": [{
                      "rule_index": 1,
                      "source": "10.0.0.0/24",
                      "destination": [
                          "192.168.44.0/24"
                      ]
                  }],
                  "ikepolicy": {
                      "ike_version": "v2",
                      "authentication_algorithm": "sha2-256",
                      "encryption_algorithm": "aes-128",
                      "dh_group": "group15",
                      "authentication_method": "pre-share",
                      "lifetime_seconds": 3600,
                      "local_id_type": "ip",
                      "local_id": "88.88.201.167",
                      "peer_id_type": "ip",
                      "peer_id": "10.111.222.21",
                      "dpd": {
                          "interval": 30,
                          "timeout": 15,
                          "msg": "seq-hash-notify"
                      }
                  },
                  "ipsecpolicy": {
                      "authentication_algorithm": "sha2-256",
                      "encryption_algorithm": "aes-128",
                      "pfs": "group15",
                      "transform_protocol": "esp",
                      "lifetime_seconds": 3600,
                      "encapsulation_mode": "tunnel"
                  },
                  "created_at": "2022-12-09T07:24:27.674Z",
                  "updated_at": "2022-12-09T07:24:27.674Z",
                  "enterprise_project_id": "0",
                  "ha_role":"master"
              }
          ],
          "page_info": {
              "next_marker": "2022-12-09T07:24:27.674Z",
              "current_count": 2
          },
          "request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac",
          "total_count": 2
      }
    2. 指定vgw_ip查询VPN连接的响应。
      {
          "vpn_connections": [
              {
                  "id": "8fa335dd-****-****-****-78bb55a8bb04",
                  "name": "vpn-2acd",
                  "status": "DOWN",
                  "vgw_id": "02217fb1-****-****-****-806ea291a8f2",
                  "vgw_ip": "f5acac2c-****-****-****-72b819a5f525",
                  "style": "STATIC",
                  "cgw_id": "eba04567-****-****-****-5b0352f89af0",
                  "peer_subnets": [
                      "192.168.44.0/24"
                  ],
                  "tunnel_local_address": "169.254.58.225/30",
                  "tunnel_peer_address": "169.254.58.226/30",
                  "enable_nqa": false,
                  "ikepolicy": {
                      "ike_version": "v2",
                      "authentication_algorithm": "sha2-256",
                      "encryption_algorithm": "aes-128",
                      "dh_group": "group15",
                      "authentication_method": "pre-share",
                      "lifetime_seconds": 3600,
                      "local_id_type": "ip",
                      "local_id": "88.***.***.167",
                      "peer_id_type": "ip",
                      "peer_id": "10.***.***.9",
                      "dpd": {
                          "timeout": 15,
                          "interval": 30,
                          "msg": "seq-hash-notify"
                      }
                  },
                  "ipsecpolicy": {
                      "authentication_algorithm": "sha2-256",
                      "encryption_algorithm": "aes-128",
                      "pfs": "group15",
                      "transform_protocol": "esp",
                      "lifetime_seconds": 3600,
                      "encapsulation_mode": "tunnel"
                  },
                  "created_at": "2022-12-11T14:24:25.115Z",
                  "updated_at": "2022-12-11T14:24:25.115Z",
                  "enterprise_project_id": "0"
              },
              {
                  "id": "a4df33ca-****-****-****-410a7dd6973f",
                  "name": "vpn-15ea",
                  "status": "DOWN",
                  "vgw_id": "02217fb1-****-****-****-806ea291a8f2",
                  "vgw_ip": "f5acac2c-****-****-****-72b819a5f525",
                  "style": "POLICY",
                  "cgw_id": "10a4496f-****-****-****-7510f4b2af33",
                  "tunnel_local_address": "169.254.77.169/30",
                  "tunnel_peer_address": "169.254.77.170/30",
                  "policy_rules": [
                      {
                          "rule_index": 1,
                          "source": "10.0.0.0/24",
                          "destination": [
                              "192.168.44.0/24"
                          ]
                      }
                  ],
                  "ikepolicy": {
                      "ike_version": "v2",
                      "authentication_algorithm": "sha2-256",
                      "encryption_algorithm": "aes-128",
                      "dh_group": "group15",
                      "authentication_method": "pre-share",
                      "lifetime_seconds": 3600,
                      "local_id_type": "ip",
                      "local_id": "88.88.201.167",
                      "peer_id_type": "ip",
                      "peer_id": "10.111.222.21",
                      "dpd": {
                          "interval": 30,
                          "timeout": 15,
                          "msg": "seq-hash-notify"
                      }
                  },
                  "ipsecpolicy": {
                      "authentication_algorithm": "sha2-256",
                      "encryption_algorithm": "aes-128",
                      "pfs": "group15",
                      "transform_protocol": "esp",
                      "lifetime_seconds": 3600,
                      "encapsulation_mode": "tunnel"
                  },
                  "created_at": "2022-12-11T13:59:59.633Z",
                  "updated_at": "2022-12-11T13:59:59.633Z",
                  "enterprise_project_id": "0",
                  "ha_role":"master"
              }
          ],
          "page_info": {
              "next_marker": "2022-12-11T13:59:59.633Z",
              "current_count": 2
          },
          "request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac",
          "total_count": 12
      }
    3. 指定VPN网关实例查询VPN连接的响应。
      {
          "vpn_connections": [
              {
                  "id": "8fa335dd-****-****-****-78bb55a8bb04",
                  "name": "vpn-2acd",
                  "status": "DOWN",
                  "vgw_id": "02217fb1-****-****-****-806ea291a8f2",
                  "vgw_ip": "f5acac2c-****-****-****-72b819a5f525",
                  "style": "STATIC",
                  "cgw_id": "eba04567-****-****-****-5b0352f89af0",
                  "peer_subnets": [
                      "192.168.44.0/24"
                  ],
                  "tunnel_local_address": "169.254.58.225/30",
                  "tunnel_peer_address": "169.254.58.226/30",
                  "enable_nqa": false,
                  "ikepolicy": {
                      "ike_version": "v2",
                      "authentication_algorithm": "sha2-256",
                      "encryption_algorithm": "aes-128",
                      "dh_group": "group15",
                      "authentication_method": "pre-share",
                      "lifetime_seconds": 3600,
                      "local_id_type": "ip",
                      "local_id": "88.***.***.167",
                      "peer_id_type": "ip",
                      "peer_id": "10.***.***.9",
                      "dpd": {
                          "timeout": 15,
                          "interval": 30,
                          "msg": "seq-hash-notify"
                      }
                  },
                  "ipsecpolicy": {
                      "authentication_algorithm": "sha2-256",
                      "encryption_algorithm": "aes-128",
                      "pfs": "group15",
                      "transform_protocol": "esp",
                      "lifetime_seconds": 3600,
                      "encapsulation_mode": "tunnel"
                  },
                  "created_at": "2022-12-11T14:24:25.115Z",
                  "updated_at": "2022-12-11T14:24:25.115Z",
                  "enterprise_project_id": "0",
                  "ha_role":"master"
              },
              {
                  "id": "a4df33ca-****-****-****-410a7dd6973f",
                  "name": "vpn-15ea",
                  "status": "DOWN",
                  "vgw_id": "02217fb1-****-****-****-806ea291a8f2",
                  "vgw_ip": "f5acac2c-****-****-****-72b819a5f525",
                  "style": "POLICY",
                  "cgw_id": "10a4496f-****-****-****-7510f4b2af33",
                  "tunnel_local_address": "169.254.77.169/30",
                  "tunnel_peer_address": "169.254.77.170/30",
                  "policy_rules": [
                      {
                          "rule_index": 1,
                          "source": "10.0.0.0/24",
                          "destination": [
                              "192.168.44.0/24"
                          ]
                      }
                  ],
                  "ikepolicy": {
                      "ike_version": "v2",
                      "authentication_algorithm": "sha2-256",
                      "encryption_algorithm": "aes-128",
                      "dh_group": "group15",
                      "authentication_method": "pre-share",
                      "lifetime_seconds": 3600,
                      "local_id_type": "ip",
                      "local_id": "88.88.201.167",
                      "peer_id_type": "ip",
                      "peer_id": "10.111.222.21",
                      "dpd": {
                          "interval": 30,
                          "timeout": 15,
                          "msg": "seq-hash-notify"
                      }
                  },
                  "ipsecpolicy": {
                      "authentication_algorithm": "sha2-256",
                      "encryption_algorithm": "aes-128",
                      "pfs": "group15",
                      "transform_protocol": "esp",
                      "lifetime_seconds": 3600,
                      "encapsulation_mode": "tunnel"
                  },
                  "created_at": "2022-12-11T13:59:59.633Z",
                  "updated_at": "2022-12-11T13:59:59.633Z",
                  "enterprise_project_id": "0",
                  "ha_role":"master"
              }
          ],
          "page_info": {
              "next_marker": "2022-12-11T13:59:59.633Z",
              "current_count": 2
          },
          "request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac",
          "total_count": 12
      }

状态码

请参见状态码

分享:

    相关文档

    相关产品