Consulta de uma conexão de VPN especificada

Função

Esta API é usada para consultar uma conexão de VPN com um ID de conexão especificado.

URI

Solicitação

• Parâmetros de solicitação

  Nenhum

Resposta

• Parâmetros de resposta

  Código de status 200 retornado: operação bem-sucedida

  Tabela 2 Parâmetros no corpo da resposta

  Parâmetro	Tipo	Descrição
  vpn_connection	ResponseVpnConnection	Especifica o objeto de conexão de VPN.
  request_id	String	Especifica um ID da solicitação.

  Tabela 3 ResponseVpnConnection

  Parâmetro	Tipo	Descrição
  id	String	Especifica um ID de conexão de VPN. O valor é um UUID contendo 36 caracteres.
  name	String	Especifica um nome de conexão de VPN. Se nenhum nome de conexão de VPN for especificado, o sistema gerará um automaticamente. O valor é uma cadeia de 1 a 64 caracteres, que pode conter dígitos, letras, sublinhados (_) e hifens (-).
  status	String	Especifica o status da conexão de VPN. Intervalo de valores: ERROR: anormal ACTIVE: normal DOWN: não conectado PENDING_CREATE: criando PENDING_UPDATE: atualizando PENDING_DELETE: excluindo FREEZED: congelado
  vgw_id	String	Especifica um ID de gateway de VPN. O valor é um UUID contendo 36 caracteres.
  vgw_ip	String	Especifica um ID do EIP ou um endereço IP privado do gateway de VPN. O valor é um UUID contendo 36 caracteres ou um endereço IPv4 em notação decimal pontilhada (por exemplo, 192.168.45.7).
  style	String	Especifica o modo de conexão. Intervalo de valores: POLICY: modo baseado em políticas STATIC: modo de roteamento estático BGP: modo de roteamento BGP
  cgw_id	String	Especifica um ID de gateway de cliente. O valor é um UUID contendo 36 caracteres.
  peer_subnets	Array of String	Especifica uma sub-rede de cliente. Este parâmetro não é retornado quando o modo de associação do gateway de VPN é ER e style é BGP ou POLICY.
  tunnel_local_address	String	Especifica o endereço da interface de túnel configurado no gateway de VPN no modo baseado em rota. Este parâmetro é válido somente quando style é STATIC ou BGP.
  tunnel_peer_address	String	Especifica o endereço da interface de túnel configurado no dispositivo de gateway do cliente no modo baseado em rota. Este parâmetro é válido somente quando style é STATIC ou BGP.
  enable_nqa	Boolean	Especifica se NQA está ativada. Este parâmetro é válido somente quando style é STATIC. O valor pode ser true ou false.
  policy_rules	Array of PolicyRule	Especifica regras de política. As regras de política são retornadas somente quando style é POLICY.
  ikepolicy	IkePolicy	Especifica o objeto de política IKE.
  ipsecpolicy	IpsecPolicy	Especifica o objecto de política IPsec.
  created_at	String	Especifica a hora em que a conexão de VPN é criada.
  updated_at	String	Especifica a hora da última atualização.
  enterprise_project_id	String	Especifica um ID do projeto empresarial. O valor é um UUID contendo 36 caracteres. O valor deve ser o mesmo que o ID do projeto empresarial do gateway de VPN especificado por vgw_id.

  Tabela 4 PolicyRule

  Parâmetro	Tipo	Descrição
  rule_index	Integer	Especifica um ID de regra. O valor varia de 0 a 50.
  source	String	Especifica um bloco CIDR de origem.
  destination	Array of String	Especifica um bloco CIDR de destino. Por exemplo, um bloco CIDR de destino pode ser 192.168.52.0/24. Um máximo de 50 blocos CIDR de destino pode ser retornado para cada regra de política.

  Tabela 5 IkePolicy

  Parâmetro	Tipo	Descrição
  ike_version	String	Especifica a versão do IKE. O valor pode ser v1 ou v2.
  phase1_negotiation_mode	String	Especifica o modo de negociação. Esse parâmetro está disponível somente quando a versão do IKE é v1. Intervalo de valores: main: garante alta segurança durante a negociação. aggressive: garante negociação rápida e uma alta taxa de sucesso de negociação.
  authentication_algorithm	String	Especifica um algoritmo de autenticação. O valor pode ser sha2-512, sha2-384, sha2-256, sha1 ou md5.
  encryption_algorithm	String	Especifica um algoritmo de criptografia. O valor pode ser aes-256-gcm-16, aes-128-gcm-16, aes-256, aes-192, aes-128 ou 3des.
  dh_group	String	Especifica o grupo de DH usado para troca de chaves na fase 1. O valor pode ser group1, group2, group5, group14, group15, group16, group19, group20 ou group21.
  authentication_method	String	Especifica o método de autenticação usado durante a negociação IKE. Intervalo de valores: pre-share: chave pré-compartilhada
  lifetime_seconds	Integer	Especifica o tempo de vida da associação de segurança. Quando o tempo de vida expira, uma associação de segurança do IKE é atualizada automaticamente. O valor varia de 60 a 604800, em segundos.
  local_id_type	String	Especifica o tipo de ID local. O valor pode ser ip ou fqdn.
  local_id	String	Especifica o ID local. Quando local_id_type é definido como ip, o endereço IP do gateway de VPN correspondente à conexão de VPN é retornado. Quando local_id_type é definido como fqdn, o ID local especificado durante a criação ou atualização da conexão de VPN é retornado.
  peer_id_type	String	Especifica o tipo de ID de par. O valor pode ser ip, fqdn ou any.
  peer_id	String	Especifica o ID de par. Quando peer_id_type é definido como ip, o endereço IP do gateway de cliente é retornado. Quando peer_id_type é definido como fqdn, o ID de par especificado durante a criação ou atualização da conexão de VPN é retornado. Quando peer_id_type é definido como any, nenhum dado é retornado.
  dpd	Dpd	Especifica o objeto da DPD.

  Tabela 6 Dpd

  Parâmetro	Tipo	Descrição
  timeout	Integer	Especifica o intervalo para retransmissão de pacotes da DPD. O valor varia de 2 a 60, em segundos.
  interval	Integer	Especifica o período de tempo limite de inatividade da DPD. O valor varia de 10 a 3600, em segundos.
  msg	String	Especifica o formato dos pacotes da DPD. Intervalo de valores: seq-hash-notify: indica que a carga útil de pacotes da DPD está na sequência de hash-notify. seq-notify-hash: indica que a carga útil de pacotes da DPD está na sequência de notify-hash.

  Tabela 7 IpsecPolicy

  Parâmetro	Tipo	Descrição
  authentication_algorithm	String	Especifica um algoritmo de autenticação. O valor pode ser sha2-512, sha2-384, sha2-256, sha1 ou md5.
  encryption_algorithm	String	Especifica um algoritmo de criptografia. O valor pode ser aes-256-gcm-16, aes-128-gcm-16, aes-256, aes-192, aes-128 ou 3des.
  pfs	String	Especifica o grupo de chaves DH usado pelo PFS. O valor pode ser group1, group2, group5, group14, group15, group16, group19, group20, group21 ou disable.
  transform_protocol	String	Especifica o protocolo de transferência. Intervalo de valores: esp: encapsulamento de protocolo de carga útil de segurança
  lifetime_seconds	Integer	Especifica o tempo de vida de um túnel estabelecido através de uma conexão IPsec. O valor varia de 30 a 604800, em segundos.
  encapsulation_mode	String	Especifica o modo de encapsulamento de pacotes. Intervalo de valores: tunnel: encapsula pacotes em modo de túnel.

• Exemplo de resposta

  {
      "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 status

Para mais detalhes, consulte Códigos de status.