功能介绍

根据连接ID，查询指定的VPN连接的参数。

URI

GET /v5/{project_id}/vpn-connection/{vpn_connection_id}

请求消息

• 请求参数

  无

响应消息

• 响应参数

  返回状态码为 200: successful operation

  表2 响应Body参数列表

  名称	类型	描述
  vpn_connection	ResponseVpnConnection object	vpn_connection对象
  request_id	String	请求ID

  表3 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：冻结中
  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路由模式
  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时返回实际的策略规则组，当style为STATIC或BGP时不返回。
  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

  表4 PolicyRule

  名称	类型	描述
  rule_index	Integer	功能说明：规则ID 取值范围：0-50
  source	String	源地址网段
  destination	Array of String	目的地址网段。单个网段格式示例：192.168.52.0/24。每个PolicyRule最多返回50个。

  表5 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：预共享密钥 digital-envelope-v2：国密数字信封
  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	对等体存活检测对象

  表6 Dpd

  名称	类型	描述
  timeout	Integer	功能说明：对等体存活检测报文重传间隔 取值范围：2-60，单位：秒。
  interval	Integer	功能说明：对等体存活检测空闲时间 取值范围：10-3600，单位：秒。
  msg	String	功能说明：对等体存活检测报文格式 取值范围： seq-hash-notify：指定DPD报文中的载荷顺序是hash-notify。 seq-notify-hash：指定DPD报文中的载荷顺序是notify-hash。

  表7 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：隧道模式

• 响应样例

  {
      "vpn_connection": {
          "id": "98c5af8a-****-****-****-ae2280a6f4c3",
          "name": "vpn-1655",
          "status": "DOWN",
          "vgw_id": "b32d91a4-****-****-****-e907174eb11d",
          "vgw_ip": "0c464dad-****-****-****-c22bb0eb0bde",
          "style": "POLICY",
          "cgw_id": "5247ae10-****-****-****-dd36659a7f5d",
          "peer_subnets": ["192.168.0.0/24"],
          "tunnel_local_address": "169.254.56.225/30",
          "tunnel_peer_address": "169.254.56.226/30",
          "policy_rules": [{
              "rule_index": 1,
              "source": "10.0.0.0/24",
              "destination": [
                  "192.168.0.0/24"
              ]
          }],
          "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.***.***.134",
              "peer_id_type": "ip",
              "peer_id": "88.***.***.164",
              "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-11-26T13:41:34.626Z",
          "updated_at": "2022-11-26T13:41:34.626Z",
          "enterprise_project_id": "0",
          "ha_role":"master"
      },
      "request_id": "f91082d4-6d49-479c-ad1d-4e552a9f5cae"
  }

状态码

请参见状态码