Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

EN ESTA PÁGINA
 

Ejemplo: uso del Explorador de API de REST

En este ejemplo, se muestra cómo usar opcionalmente el Explorador de API de REST en un Junos OS en el que se configuró la API de REST.

Requisitos

  • Se requiere M Series, serie MX, serie T o serie PTX que se ejecute Junos OS versión 14.2 o posterior.

Visión general

El Explorador de API de REST le permite probar cómodamente una o varias llamadas RPC. Su GUI le proporciona opciones para seleccionar el método HTTP (GET o POST), el formato de salida necesario (XML, XML o texto sin formato), la DIRECCIÓN URL RPC, el tipo de datos de entrada cuando se utilizan solicitudes POST (XML o texto sin formato) y una condición exit-on-error. Cuando envía la solicitud, el Explorador de API de REST muestra el encabezado de la solicitud, el encabezado de respuesta, el cuerpo de respuesta y la solicitud cURL equivalente, todas las cuales son útiles para sus esfuerzos de desarrollo.

Configuración

Para usar el Explorador de API de REST en cualquier dispositivo en el que se haya configurado la API de REST, realice estas tareas:

Habilitar el Explorador de API de REST

Procedimiento paso a paso

Para habilitar el Explorador de API de REST:

  1. Configure la API de REST en el dispositivo.

    Consulte Configuración de la API de REST y Ejemplo: configuración de la API de REST para obtener información y ejemplos.

  2. Compruebe si el Explorador de API de REST está habilitado.

    Use el show comando para ver si aparece en la configuración de la API de enable-explorer; REST. Si aparece, se ha habilitado el Explorador de API de REST. Si no aparece, debe habilitar el Explorador de API de REST.

  3. Habilite el Explorador de API de REST si fuera necesario.

    Use el set comando para asegurarse de que aparece en la configuración de la API de enable-explorer; REST.

Apertura del Explorador de API de REST

Procedimiento paso a paso

Para abrir el Explorador de API de REST:

  • Asegúrese de que el Explorador de API de REST está habilitado, abra un navegador y vaya a la siguiente dirección URL: scheme://device-name:port (por ejemplo, https://mydevice:3000).

Ejecutar una sola RPC mediante una solicitud HTTP GET

Procedimiento paso a paso

Para ejecutar una sola RPC mediante una solicitud HTTP GET:

  1. En la lista desplegable Método HTTP, seleccione GET.

  2. Escriba el punto de conexión de dirección URL RPC.

    Por ejemplo, escriba /rpc/get-software-information .

  3. Ingrese su nombre de usuario y contraseña.

  4. Haga clic en Enviar.

    En este ejemplo, el formato de salida predeterminado, XML, se devuelve en el cuerpo de respuesta:

Ejecutar una sola RPC mediante una solicitud HTTP POST

Procedimiento paso a paso

Para ejecutar una sola RPC mediante una solicitud HTTP POST:

  1. En la lista desplegable Método HTTP, seleccione POST.

  2. En la lista desplegable Formato de salida obligatorio, seleccione JSON.

  3. Ingrese este punto de conexión de dirección URL RPC: /rpc/get-software-information .

  4. Ingrese su nombre de usuario y contraseña.

  5. Escriba la solicitud con formato XML en el área de texto Del cuerpo de la solicitud.

    Por ejemplo:

  6. Haga clic en Enviar.

    En este ejemplo, el formato de salida DERRR se devuelve en el cuerpo de respuesta:

  7. Si prefiere un formato de salida diferente, seleccione una de las opciones disponibles en la lista desplegable Formato de salida obligatorio.

    Por ejemplo, puede seleccionar Texto sin formato. Cuando haga clic en Enviar,verá texto sin formato en el cuerpo de respuesta:

    De forma similar, si selecciona XML en la lista desplegable Formato de salida obligatorio, el cuerpo de respuesta contendrá información con formato XML:

Ejecutar varias RPC

Procedimiento paso a paso

Para ejecutar varias RPC:

  1. En la lista desplegable Método HTTP, seleccione POST.

    Esto siempre es obligatorio cuando se ejecutan varias RPC.

  2. Para establecer una salida condicional en caso de error, seleccione la casilla De salida al error.

  3. Seleccione un formato de salida en la lista desplegable Formato de salida obligatorio.

    Por ejemplo, puede seleccionar JSON.

  4. Este punto de conexión de URL RPC se completará automáticamente: /rpc?exit-on-error=1 .

  5. Ingrese su nombre de usuario y contraseña.

  6. Escriba la solicitud con formato XML en el área de texto Del cuerpo de la solicitud.

    Por ejemplo:

  7. Haga clic en Enviar.

    En este ejemplo, el formato de salida DERRR se devuelve en el cuerpo de respuesta:

Visualización de mensajes de error

Procedimiento paso a paso

Al ejecutar varias RPC, puede producirse un error. Si selecciona la casilla de verificación Salir con error, aparecerá un mensaje de error en el resultado si se produce un error.

Para ver los mensajes de error:

  1. En la lista desplegable Método HTTP, seleccione POST.

    Esto siempre es obligatorio cuando se ejecutan varias RPC.

  2. Para establecer una salida condicional en caso de error, seleccione la casilla De salida al error.

  3. Seleccione un formato de salida en la lista desplegable Formato de salida obligatorio.

    Por ejemplo, puede seleccionar JSON.

  4. Este punto de conexión de URL RPC se completará automáticamente: /rpc?exit-on-error=1 .

  5. Ingrese su nombre de usuario y contraseña.

  6. Escriba la solicitud con formato XML que contiene un error en el área de texto Solicitar cuerpo.

    Por ejemplo:

  7. Haga clic en Enviar.

    En este ejemplo, el formato de salida JSON se devuelve en el cuerpo de respuesta y puede ver un mensaje de error con formato XML al final del cuerpo de respuesta:

  8. Si no selecciona la casilla De salida al error, aparecerá un mensaje de error en el cuerpo de respuesta si se produce un error.

    La ejecución continuará después de procesar el error y los resultados también se incluirán en el cuerpo de respuesta:

Documentación relacionada