Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

Configuração da REST API

A API REST pode ser configurada em dispositivos Junos OS usando comandos disponíveis no nível de [edit system services rest] hierarquia. Uma vez configurada, a REST API fica disponível como serviço rest , uma interface baseada em REST que permite enviar comandos rpc ao dispositivo a partir de um local remoto e oferece suporte a solicitações GET e POST.

Para habilitar a REST API em seu dispositivo, você precisa configurar:

  • Parâmetros de controle — Estes permitem que você especifique opcionalmente endereços IP de origem permitidos e limites de conexão comuns a conexões HTTP e HTTPS.

  • REST API Explorer— A REST API oferece uma GUI chamada REST API Explorer, que permite que você aprenda a usar a REST API com facilidade e rapidez. Ele é desativado por padrão e pode ser habilitado especificando set system services rest enable-explorer. Para saber mais sobre o REST API Explorer, veja Exemplo: Usando o REST API Explorer.

  • Acesso HTTP — Você pode especificar uma lista de endereços e portas TCP para conexões de entrada. As conexões HTTP não são seguras porque trocam credenciais e dados em texto claro, por isso recomendamos o uso de HTTPS.

  • Acesso HTTPS (recomendado)— Você pode especificar uma lista de endereços e portas TCP para conexões de entrada, uma lista de suítes cifradas preferidas, autenticação mútua de segurança de camada de transporte (TLS) e certificados de servidor. As conexões HTTPS são seguras, criptografando credenciais e informações.

  • Trace opções— Você pode habilitar o rastreamento para lighttpd, ambiente de script de interface de usuário (juise), ou ambos. As informações de rastreamento de lighttpd são armazenadas em /var/chroot/rest-api/var/log/lighttpd, e as informações de rastreamento para juise são armazenadas em /var/chroot/rest-api/var/log/juise. O rastreamento é desativado por padrão.

Para configurar os parâmetros de controle opcionais para configurações comuns a conexões HTTP e HTTPS:

  1. Especifique set system services rest control allowed-sources [ value-list ] para definir os endereços IP permitidos para conexões HTTP e HTTPS. Use espaços como delimiters entre valores.
  2. Especifique set system services rest control connection-limit limit para definir o número máximo de conexões simultâneas permitidas para conexões HTTP e HTTPS. Você pode atribuir um valor de 1 a 1024 (o padrão é 64).

Para configurar o acesso HTTP:

  1. Especifique set system services rest http addresses [ addresses ] para definir os endereços nos quais o servidor ouve as próximas conexões HTTP.

  2. Especifique set system services rest http port port-number para definir a porta TCP para conexões HTTP de entrada. Você pode atribuir um valor de 1024 a 65535 (o padrão é 3000).

Para configurar o acesso HTTPS:

  1. Especifique set system services rest https addresses [ addresses ] para definir os endereços nos quais o servidor ouve as conexões HTTPS de entrada.

  2. Especifique set system services rest https port port-number para definir a porta TCP para conexões HTTPS de entrada. Você pode atribuir um valor de 1024 a 65535 (o padrão é 3443).

  3. Especifique set system services rest https cipher-list[cipher-1 cipher-2 cipher-3 ... ] para configurar o conjunto de suítes cifradas que o servidor SSH pode usar para executar funções de criptografia e descriptografia.

  4. Especifique set system services rest https server-certificate local-certificate-identifier para configurar o certificado do servidor. Consulte a solicitação de pki de geração de certificados para obter informações sobre a criação de certificados locais.

  5. Você pode configurar a REST API para exigir autenticação de servidor sem autenticação do cliente, ou pode configurar a autenticação mútua de TLS no servidor e no cliente especificando set system services rest https mutual-authentication certificate-authority certificate-authority-profile-name.

Para configurar opções de rastreamento para lighttpd, juise ou ambos, especifique set system services rest traceoptions flag flag. Definir flag para lighttpd, juiseou all. Quando você especifica as opções de rastreamento, o comando substitui qualquer configuração de opção de rastreamento anterior.

Nota:

Uso elevado de CPU por sistematizado na Série ACX7100: em plataformas ACX7100 que executam o Junos EVO, o systemd processo pode mostrar o uso de CPU acima do esperado em condições normais. Isso ocorre mesmo quando determinados serviços (por exemplo, REST, syslog) são desativados. Não há nenhum impacto funcional observado.

Documentação relacionada