Descripción de la API de REST
La API de REST es una interfaz de transferencia de estado representacional (REST) que le permite conectarse de forma segura Juniper Networks Sistema operativo de Junos dispositivos Juniper Networks Sistema operativo de Junos (Junos OS), ejecutar llamadas de procedimiento remotos ( comandos), usar una GUI del explorador de API de REST que le permite experimentar de forma cómoda con cualquiera de las API de REST y usar una variedad de opciones de formato y visualización, incluida la Notación de objetos rpc JavaScript (JSON).
La API de REST se puede configurar en Junos OS dispositivos con comandos disponibles en el [edit system services rest] nivel jerárquido. Una vez configurada, la API de REST está disponible como servicio, una interfaz basada en REST que permite enviar comandos al dispositivo desde una ubicación remota y admite solicitudes GET y rest rpc POST. Con la API de REST puede:
Use solicitudes GET para enviar
rpccomandos.Use solicitudes POST para enviar información a través
rpcde comandos.Recupere la información de configuración en XML, ASCII (texto sin formato) o ASCII.
Recupere datos operativos en XML, ASCII o JSON.
En el nivel de jerarquía, puede configurar y proteger el servicio de API de REST en un dispositivo Junos OS; configurar direcciones IP, números de puerto, certificados de servidor, parámetros de control y opciones de seguimiento; y habilitar una herramienta de explorador de API de REST que permita probar las API de REST mediante una interfaz gráfica de usuario [edit system services rest] práctica.
Las siguientes CLI opciones de visualización están disponibles:
Se
display jsonagrega una opción al | (canalización) Comando. Por ejemplo, el comando CLI muestrashow interfaces | display jsonlas interfaces en la notación JSON.Se
format="json"agrega una opción a los comandos del servidor NETCONF para devolver la información operativa en la notación JSON.
A partir de Junos OS versión 17.3R1, OpenConfig admite el estado operativo emitido por los daemons directamente en formato HTML, además del formato XML. Para configurar el formato compacto DERR, especifique el comando CLI siguiente: set system export-format state-data json compact . Este CLI comando convierte el formato XML a formatoSON COMPACTO. De lo contrario, emite ELR en formato no compacto.
El tamaño de la carga de la solicitud entrante de la API de REST no puede superar los 1174 KB.
Solución alternativa: Fragmentar las solicitudes de API de REST entrantes en un tamaño más pequeño.
La API de REST admite la autenticación básica HTTP y todas las solicitudes requieren un nombre de usuario y una contraseña codificados en base64 incluidos en el encabezado Authorization. La compatibilidad con HTTP y HTTPS está disponible:
Puede usar HTTP para intercambiar contenido con texto sin formato si no necesita una conexión segura.
Recomendamos que utilice HTTPS para intercambiar contenido cifrado mediante uno de los conjuntos de cifrado disponibles. Puede configurar la API de REST para que requiera autenticación de servidor sin autenticación de cliente o puede configurar la autenticación mutua.
Una vez que la API de REST está configurada en el dispositivo, hay nuevos puntos de conexión de REST disponibles para ejecutar comandos únicos a través de solicitudes GET o POST, o para ejecutar varios comandos mediante una sola solicitud rpc rpc POST. Consulte Enviar una solicitud GET a la API de REST y Enviar una solicitud POST a la API de REST para obtener más información.
La API de REST también proporciona una GUI denominada Explorador de API de REST, la cual le permite aprender a usar la API de REST de manera sencilla y rápida. Está deshabilitada de forma predeterminada y se puede habilitar mediante la especificación set system services rest enable-explorer . Para obtener más información acerca del Explorador de API de REST, consulte Ejemplo: Uso del Explorador de API de REST.