Acceda a las API de ONTAP a través del acceso proxy
Sugerir cambios
PDF
Las API de puerta de enlace le brindan la ventaja de usar las credenciales de Active IQ Unified Manager para ejecutar las API REST de ONTAP y administrar objetos de almacenamiento. Estas API están disponibles cuando la función API Gateway está habilitada desde la interfaz de usuario web de Unified Manager.
Las API REST de Unified Manager solo admiten un conjunto selecto de acciones que se realizarán en las fuentes de datos de Unified Manager, es decir, los clústeres de ONTAP . Puede aprovechar las demás funciones a través de las API de ONTAP . Las API de puerta de enlace permiten que Unified Manager sea una interfaz de paso para tunelizar todas las solicitudes de API que se realizarán en los clústeres de ONTAP que administra, sin tener que iniciar sesión en cada clúster de centro de datos individualmente. Funciona como un único punto de administración para ejecutar las API en los clústeres de ONTAP administrados por su instancia de Unified Manager. La función API Gateway permite que Unified Manager sea un único plano de control desde el cual puede administrar múltiples clústeres de ONTAP , sin iniciar sesión en ellos individualmente. Las API de puerta de enlace le permiten permanecer conectado a Unified Manager y administrar los clústeres de ONTAP ejecutando operaciones de API REST de ONTAP .
|
Todos los usuarios pueden ejecutar una consulta utilizando la operación GET. Los administradores de aplicaciones pueden ejecutar todas las operaciones REST de ONTAP . |
La puerta de enlace actúa como un proxy para tunelizar las solicitudes de API manteniendo el encabezado y el cuerpo de las solicitudes en el mismo formato que en las API de ONTAP . Puede usar sus credenciales de Unified Manager y ejecutar operaciones específicas para acceder y administrar los clústeres de ONTAP sin pasar credenciales de clúster individuales. Continúa administrando la autenticación y la gestión del clúster, pero redirige las solicitudes de API para que se ejecuten directamente en el clúster específico. La respuesta devuelta por las API es la misma que la respuesta devuelta por las respectivas API REST de ONTAP ejecutadas directamente desde ONTAP.
| verbo HTTP | Ruta (URL) | Descripción | ||
|---|---|---|---|---|
|
|
Este método GET recupera la lista de todos los clústeres administrados por Unified Manager que admiten llamadas ONTAP REST. Puede verificar los detalles del clúster y elegir ejecutar otros métodos según el UUID del clúster o el identificador único universal (UUID).
|
||
|
|
Esta es una API de proxy de punto único, que admite operaciones POST, DELETE, PATCH y GET para todas las API REST de ONTAP . No se aplican restricciones a ninguna de las API siempre que sean compatibles con ONTAP. No se puede desactivar la funcionalidad de tunelización o proxy. El El |
Comprender la tunelización de API Gateway
Las API de puerta de enlace le permiten administrar objetos ONTAP a través de Unified Manager. Unified Manager administra los clústeres y los detalles de autenticación y redirige las solicitudes al punto final REST de ONTAP . La API de puerta de enlace transforma la URL y los vínculos de Hypermedia como Motor de Estado de la Aplicación (HATEOAS) en el encabezado y el cuerpo de la respuesta con la URL base de la puerta de enlace de API. La API de puerta de enlace actúa como la URL base del proxy a la que se agrega la URL REST de ONTAP y se ejecuta el punto final REST de ONTAP requerido.
|
|
Para que una API de ONTAP se ejecute correctamente a través de API Gateway, la API debe ser compatible con la versión del clúster de ONTAP en el que se ejecuta. La ejecución de una API que no es compatible con el clúster ONTAP no devuelve ningún resultado. |
En este ejemplo, la API de puerta de enlace (URL base del proxy) es: /gateways/{uuid}/
La API de ONTAP tomada es: /storage/volumes . Debe agregar la URL REST de la API de ONTAP como valor para el parámetro de ruta.
|
|
Al agregar la ruta, asegúrese de haber eliminado el “/” symbol at the beginning of the URL. For the API |
La URL adjunta es: /gateways/{uuid}/storage/volumes
Al ejecutar el GET operación, la URL generada es la siguiente: GEThttps://<hostname\>/api/gateways/<cluster_UUID\>/storage/volumes
El /api La etiqueta de la URL REST de ONTAP se elimina en la URL adjunta y se conserva la de la API de puerta de enlace.
Ejemplo de comando cURL
curl -X GET "https://<hostname>/api/gateways/1cd8a442-86d1-11e0-ae1c-9876567890123/storage/volumes" -H "accept: application/hal+json" -H "Authorization: Basic <Base64EncodedCredentials>"
La API devuelve la lista de volúmenes de almacenamiento en ese clúster. El formato de respuesta es el mismo que recibes cuando ejecutas la misma API desde ONTAP. Los códigos de estado devueltos son los códigos de estado ONTAP REST.
Establecer el alcance de la API
Todas las API tienen un contexto establecido dentro del alcance del clúster. Las API que operan sobre la base de máquinas virtuales de almacenamiento también tienen el clúster como alcance, es decir, las operaciones de la API se realizan en una máquina virtual de almacenamiento particular dentro de un clúster administrado. Cuando se ejecuta el /gateways/{uuid}/{path} API, asegúrese de ingresar el UUID del clúster (UUID de la fuente de datos de Unified Manager) para el clúster en el que ejecuta la operación. Para establecer el contexto de una máquina virtual de almacenamiento en particular dentro de ese clúster, ingrese la clave de la máquina virtual de almacenamiento como el parámetro X-Dot-SVM-UUID o el nombre de la máquina virtual de almacenamiento como el parámetro X-Dot-SVM-Name. El parámetro se agrega como filtro en el encabezado de la cadena y la operación se ejecuta dentro del alcance de esa máquina virtual de almacenamiento dentro de ese clúster.
Ejemplo de comando cURL
curl -X GET "https://<hostname>/api/gateways/e4f33f90-f75f-11e8-9ed9-00a098e3215f/storage/volume" -H "accept: application/hal+json" -H "X-Dot-SVM-UUID: d9c33ec0-5b61-11e9-8760-00a098e3215f" -H "Authorization: Basic <Base64EncodedCredentials>"
Para obtener más información sobre el uso de las API REST de ONTAP , consultehttps://docs.netapp.com/us-en/ontap-automation/index.html["Automatización de API REST de ONTAP"]