Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

Configurando a API REST

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

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

  • Parâmetros de controle — É possível especificar opcionalmente endereços IP de origem permitida e limites de conexão comuns a conexões HTTP e HTTPS.

  • REST API Explorer — a API REST fornece uma GUI chamada REST API Explorer, que permite que você aprenda facilmente e rapidamente como usar a API REST. Ele é desabilitado por padrão e pode ser ativado especificando set system services rest enable-explorer . Para saber mais sobre o REST API Explorer, consulte 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 suites cifrados preferidos, autenticação mútua de segurança da camada de transporte (TLS) e certificados de servidor. As conexões HTTPS são seguras, criptografando credenciais e informações.

  • Opções de rastreamento — Você pode habilitar o rastreamento para lighttpd, User Interface Script Environment (juise) ou ambos. As informações de rastreamento para 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 é inválido por padrão.

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

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

Para configurar o acesso HTTP:

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

  2. set system services rest http port port-numberEspecifique para definir a porta TCP para conexões HTTP próximas. Você pode designar um valor de 1024 a 65535 (o padrão é 3000).

Para configurar o acesso a HTTPS:

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

  2. set system services rest https port port-numberEspecifique para definir a porta TCP para conexões HTTPS próximas. Você pode designar um valor de 1024 a 65535 (o padrão é 3443).

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

  4. set system services rest https server-certificate local-certificate-identifierEspecifique para configurar o certificado do servidor. Consulte solicitar solicitação de segurança pki gerar-certificado-solicitação de informações sobre a criação de certificados locais.

  5. Você pode configurar a API REST para exigir autenticação do servidor sem autenticação do cliente ou configurar a autenticação mútua 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, set system services rest traceoptions flag flag. especifique Definir flag lighttpd juise para, ou all . Quando você especifica as opções de rastreamento, o comando sobregrava quaisquer configurações de opção de rastreamento anteriores.

Documentação relacionada