Puede acceder a la API de REST DE ONTAP directamente mediante curl o un lenguaje de programación. En este caso, la URL base es diferente de la URL que utiliza al acceder a la documentación en línea de ONTAP o al Administrador del sistema.

Al acceder a la API directamente, debe agregar api al dominio o la dirección IP. Por ejemplo:

https://ontap.demo-example.com/api

Consulte "Cómo acceder a la API de REST de ONTAP" si quiere más información.

Hay varios parámetros de entrada que se utilizan comúnmente con la mayoría de las llamadas a la API REST. Estos parámetros normalmente no se describen en los flujos de trabajo individuales. Debe estar familiarizado con los parámetros. Consulte "Variables de entrada que controlan una solicitud API" si quiere más información.

Si se necesitan parámetros adicionales para una llamada a la API REST específica, se incluyen en la sección Parámetros de entrada adicionales para el ejemplo de cURL para cada flujo de trabajo.

Los valores de ID y otras variables que se utilizan con los ejemplos de flujo de trabajo son opacos y pueden variar con cada clúster de ONTAP. Para mejorar la legibilidad de los ejemplos, no se utilizan los valores reales. En su lugar, se utilizan variables. Este enfoque, basado en un formato coherente y un conjunto de nombres reservados, tiene varias ventajas, entre las que se incluyen:

Las variables se formatean para ser utilizadas en un entorno de shell Bash. Cada variable comienza con un signo de dólar y está encerrada entre comillas dobles según sea necesario. Esto los hace reconocibles a Bash. Las mayúsculas se utilizan sistemáticamente para los nombres.

Estas son algunas de las palabras clave de variable común. Esta lista no es exhaustiva y se utilizan variables adicionales según sea necesario. Su significado debe ser obvio basado en el contexto.

Algunas de las llamadas a la API de REST, como las que utilizan POST o PARCHE, requieren entrada JSON en el cuerpo de la solicitud. Los ejemplos de entrada JSON se presentan por separado de los ejemplos de rizo para mayor claridad. Puede utilizar los ejemplos de entrada JSON con una de las técnicas descritas a continuación.

Puede copiar el ejemplo de entrada JSON en un archivo y guardarlo localmente. El comando cURL hace referencia al archivo que utiliza --data parámetro con el valor que indica el nombre de archivo con a. @ prefijo.

Primero debe copiar y pegar el ejemplo de cURL en un shell de terminal. A continuación, edite el ejemplo para eliminar completamente el --data parámetro al final y sustitúyalo por el --data-raw parámetro. Por último, copie y pegue en el ejemplo JSON para que siga el comando cURL con el parámetro actualizado. Debe utilizar comillas simples para ajustar el ejemplo de entrada JSON.

Cuando se utiliza la autenticación básica, las credenciales de usuario se deben incluir con cada solicitud HTTP. Hay dos opciones para enviar las credenciales.

Puede crear manualmente la cabecera Autorización e incluirla con las solicitudes HTTP. Esto se puede hacer cuando se utiliza un comando curl en la CLI o un lenguaje de programación con su código de automatización. Los pasos de alto nivel incluyen:

Los ejemplos de curl de flujo de trabajo incluyen este encabezado con la variable $BASIC_AUTH que debe actualizar antes de usar.

Otra opción cuando se usa curl es quitar el encabezado de Autorización y usar el parámetro curl user en su lugar. Por ejemplo:

--user username:password

Debe sustituir las credenciales adecuadas para su entorno. Las credenciales no están codificadas en base64. Al ejecutar el comando curl con este parámetro, la cadena se codifica y se genera la cabecera de autorización.

Al utilizar OAuth 2,0, es necesario solicitar un token de acceso desde un servidor de autorización externo e incluirlo con cada solicitud HTTP. Los pasos básicos de alto nivel se describen a continuación. Consulte también "Descripción general de la implementación de ONTAP OAuth 2,0" Para obtener más detalles sobre OAuth 2,0 y cómo usarlo con ONTAP.

Antes de usar la API de REST para acceder a ONTAP, debe preparar y configurar el entorno de ONTAP. En un nivel alto, los pasos incluyen:

Con ONTAP y el servidor de autorización definido y activo, puede realizar una llamada a la API REST mediante un token OAuth 2,0. El primer paso es solicitar un token de acceso desde el servidor de autorización. Esto se realiza fuera de ONTAP usando una de las diversas técnicas diferentes basadas en el servidor. ONTAP no emite tokens de acceso ni realiza redirecciones.

Después de obtener un token de acceso, puede crear una cabecera de autorización e incluirla con las solicitudes HTTP. Independientemente de si usa curl o un lenguaje de programación para acceder a la API REST, debe incluir el encabezado con cada solicitud del cliente. Puede construir la cabecera de la siguiente manera:

Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSld …​