Consulta de una conexión VPN especificada

Función

Esta API se utiliza para consultar una conexión VPN con un ID de conexión especificado.

URI

Solicitud

• Parámetros de solicitud

  No hay

Respuesta

• Parámetros de respuesta

  Código de estado devuelto 200: operación exitosa

  Tabla 2 Parámetros en el cuerpo de respuesta

  Parámetro	Tipo	Descripción
  vpn_connection	ResponseVpnConnection	Especifica el objeto de conexión VPN.
  request_id	String	Especifica un ID de solicitud.

  Tabla 3 ResponseVpnConnection

  Parámetro	Tipo	Descripción
  id	String	Especifica un ID de conexión VPN. El valor es un UUID que contiene 36 caracteres.
  name	String	Especifica un nombre de conexión VPN. Si no se especifica ningún nombre de conexión VPN, el sistema genera uno automáticamente. El valor es una cadena de 1 a 64 caracteres, que puede contener dígitos, letras, guiones bajos (_), y guiones (-).
  status	String	Especifica el estado de la conexión VPN. Rango de valores: ERROR: anormal ACTIVE: normal DOWN: sin conexión PENDING_CREATE: creando PENDING_UPDATE: actualizando PENDING_DELETE: eliminando FREEZED: congelado
  vgw_id	String	Especifica un ID de gateway de VPN. El valor es un UUID que contiene 36 caracteres.
  vgw_ip	String	Especifica un ID de EIP o una dirección IP privada del gateway de VPN. El valor es un UUID que contiene 36 caracteres o una dirección IPv4 en notación decimal con puntos (por ejemplo, 192.168.45.7).
  style	String	Especifica el modo de conexión. Rango de valores: POLICY: modo basado en políticas STATIC: modo de enrutamiento estático BGP: Modo de enrutamiento de BGP
  cgw_id	String	Especifica un ID de gateway de cliente. El valor es un UUID que contiene 36 caracteres.
  peer_subnets	Array of String	Especifica una subred de cliente. Este parámetro no se devuelve cuando el modo de asociación del gateway de VPN es ER y style es BGP o POLICY.
  tunnel_local_address	String	Especifica la dirección de la interfaz de túnel configurada en el gateway VPN en modo basado en ruta. Este parámetro solo es válido cuando style es STATIC o BGP.
  tunnel_peer_address	String	Especifica la dirección de la interfaz de túnel configurada en el dispositivo de gateway del cliente en modo basado en ruta. Este parámetro solo es válido cuando style es STATIC o BGP.
  enable_nqa	Boolean	Especifica si NQA está habilitado. Este parámetro solo es válido cuando style es STATIC. El valor puede ser true o false.
  policy_rules	Array of PolicyRule	Especifica reglas de política. Las reglas de política solo se devuelven cuando style tiene un valor de POLICY.
  ikepolicy	IkePolicy	Especifica el objeto de política IKE.
  ipsecpolicy	IpsecPolicy	Especifica el objeto de política IPsec.
  created_at	String	Especifica la hora a la que se crea la conexión VPN.
  updated_at	String	Especifica la hora de la última actualización.
  enterprise_project_id	String	Especifica un ID de proyecto de empresa. El valor es un UUID que contiene 36 caracteres. El valor debe ser el mismo que el ID del proyecto de empresa del gateway VPN especificada por vgw_id.

  Tabla 4 PolicyRule

  Parámetro	Tipo	Descripción
  rule_index	Integer	Especifica un ID de regla. El valor varía de 0 a 50.
  source	String	Especifica un bloque CIDR de origen.
  destination	Array of String	Especifica un bloque CIDR de destino. Por ejemplo, un bloque CIDR de destino puede ser 192.168.52.0/24. Se puede devolver un máximo de 50 bloques CIDR de destino para cada regla de política.

  Tabla 5 IkePolicy

  Parámetro	Tipo	Descripción
  ike_version	String	Especifica la versión de IKE. El valor puede ser v1 o v2.
  phase1_negotiation_mode	String	Especifica el modo de negociación. Este parámetro solo está disponible cuando la versión de IKE es v1. Rango de valores: main: asegura una alta seguridad durante la negociación. aggressive: asegura una negociación rápida y una alta tasa de éxito de la negociación.
  authentication_algorithm	String	Especifica un algoritmo de autenticación. El valor puede ser sha2-512, sha2-384, sha2-256, sha1 o md5.
  encryption_algorithm	String	Especifica un algoritmo de encriptación. El valor puede ser aes-256-gcm-16, aes-128-gcm-16, aes-256, aes-192, aes-128 o 3des.
  dh_group	String	Especifica el grupo DH utilizado para el intercambio de claves en la fase 1. El valor puede ser group1, group2, group5, group14, group15, group16, group19, group20 o group21.
  authentication_method	String	Especifica el método de autenticación utilizado durante la negociación IKE. Rango de valores: pre-share: clave precompartida
  lifetime_seconds	Integer	Especifica la duración de la SA. Cuando expira la vida útil, una SA de IKE se actualiza automáticamente. El valor varía de 60 a 604800, en segundos.
  local_id_type	String	Especifica el tipo de ID local. El valor puede ser ip o fqdn.
  local_id	String	Especifica el ID local. Cuando local_id_type se establece en ip se devuelve la dirección IP del gateway de VPN correspondiente a la conexión VPN. Cuando local_id_type se establece en fqdn, se devuelve el ID local especificado durante la creación o actualización de la conexión VPN.
  peer_id_type	String	Especifica el tipo de ID emparejado. El valor puede ser ip, fqdn o any.
  peer_id	String	Especifica el ID emparejado. Cuando peer_id_type se establece en ip, se devuelve la dirección IP del gateway del cliente. Cuando peer_id_type se establece en fqdn, se devuelve el ID emparejado especificado durante la creación o actualización de la conexión VPN. Cuando peer_id_type se establece en any, no se devuelve ningún dato.
  dpd	Dpd	Especifica el objeto DPD.

  Tabla 6 Dpd

  Parámetro	Tipo	Descripción
  timeout	Integer	Especifica el intervalo para retransmitir los paquetes de DPD. El valor varía de 2 a 60, en segundos.
  interval	Integer	Especifica el período de tiempo de espera inactivo del DPD. El valor varía de 10 a 3600, en segundos.
  msg	String	Especifica el formato de los paquetes de DPD. Rango de valores: seq-hash-notify: indica que la carga útil de los paquetes de DPD está en la secuencia de notificación-hash. seq-notify-hash: indica que la carga útil de los paquetes de DPD está en la secuencia de hash - notificación.

  Tabla 7 IpsecPolicy

  Parámetro	Tipo	Descripción
  authentication_algorithm	String	Especifica un algoritmo de autenticación. El valor puede ser sha2-512, sha2-384, sha2-256, sha1 o md5.
  encryption_algorithm	String	Especifica un algoritmo de encriptación. El valor puede ser aes-256-gcm-16, aes-128-gcm-16, aes-256, aes-192, aes-128 o 3des.
  pfs	String	Especifica el grupo de claves DH que utiliza PFS. El valor puede ser group1, group2, group5, group14, group15, group16, group19, group20, group21 o disable.
  transform_protocol	String	Especifica el protocolo de transferencia. Rango de valores: esp: protocolo de carga útil de seguridad encapsulado
  lifetime_seconds	Integer	Especifica la duración de un túnel establecido a través de una conexión IPsec. El valor oscila entre 30 y 604800, en segundos.
  encapsulation_mode	String	Especifica el modo de encapsulación de paquetes. Rango de valores: tunnel: encapsula paquetes en modo túnel.

• Ejemplo de la respuesta

  {
      "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",
          "enable_nqa": false,
          "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": "group14",
              "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": "group14",
              "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"
      },
      "request_id": "f91082d4-6d49-479c-ad1d-4e552a9f5cae"
  }

Códigos de estado

Para obtener más información, véase Códigos de estado.