Accede a las API de ONTAP mediante el acceso por proxy en Active IQ Unified Manager
Sugerir cambios
PDF
Las API de gateway te ofrecen la ventaja de usar las credenciales de Active IQ Unified Manager para ejecutar las API de REST de ONTAP y gestionar 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 de REST de Unified Manager solo admiten un conjunto concreto de acciones para realizar en los orígenes de datos de Unified Manager, es decir, los clústeres ONTAP. Puedes usar las demás funciones a través de las API de ONTAP. Las API de gateway permiten que Unified Manager actúe como una interfaz de paso para canalizar todas las solicitudes de API que se deben realizar en los clústeres ONTAP que gestiona, sin que tengas que iniciar sesión en cada clúster del centro de datos por separado. Actúa como un único punto de gestión para ejecutar las API en los clústeres ONTAP que administra tu instancia de Unified Manager. La función API Gateway permite que Unified Manager sea un único plano de control desde el que puedes gestionar varios clústeres ONTAP, sin iniciar sesión en cada uno de ellos por separado. Las API de gateway te permiten seguir con la sesión iniciada en Unified Manager y gestionar los clústeres ONTAP ejecutando operaciones de la API de REST de ONTAP.
|
Todos los usuarios pueden ejecutar una consulta mediante 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 canalizar las solicitudes de la API, manteniendo el encabezado y el cuerpo de las solicitudes en el mismo formato que en las API de ONTAP. Puedes usar tus credenciales de Unified Manager y ejecutar las operaciones específicas para acceder y gestionar los clústeres de ONTAP sin tener que introducir las credenciales de cada clúster individualmente. Sigue gestionando la autenticación y la administración del clúster, pero redirige las solicitudes de la API para que se ejecuten directamente en el clúster específico. La respuesta que devuelven las API es la misma que la que devuelven las respectivas API de 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 gestionados por Unified Manager que admiten llamadas de REST de ONTAP. Puedes comprobar los detalles del clúster y optar por ejecutar otros métodos en función del UUID del clúster o del identificador único universal (UUID).
|
||
|
|
Se trata de una API de proxy de único punto que admite operaciones POST, DELETE y PATCH, así como GET para todas las API de REST de ONTAP. No se aplica ninguna restricción a ninguna de las API, siempre que ONTAP la admita. La funcionalidad de túnel o proxy no se puede desactivar. El método El método |
Comprende el túnel de API Gateway
Las API de la pasarela te permiten gestionar objetos ONTAP a través de Unified Manager. Unified Manager gestiona los clústeres y los datos de autenticación, y redirige las solicitudes al endpoint de REST de ONTAP. La API de la pasarela transforma la URL y los enlaces HATEOAS (Hypermedia as the Engine of Application State) del encabezado y del cuerpo de la respuesta con la URL base de la pasarela de la API. La API de la pasarela actúa como la URL base del proxy a la que añades la URL de REST de ONTAP y ejecutas el endpoint de REST de ONTAP necesario.
|
|
Para que una API de ONTAP se ejecute correctamente a través de API gateway, esa API debe ser compatible con la versión del clúster de ONTAP en la que se ejecuta. Si ejecutas una API que no es compatible con el clúster de ONTAP, no obtendrás ningún resultado. |
En este ejemplo, la API de la pasarela (URL base del proxy) es: /gateways/{uuid}/
La API de ONTAP que se utiliza es: /storage/volumes. Debes añadir la URL de la API de REST de ONTAP como valor del parámetro path.
|
|
Al añadir la ruta, asegúrate de haber eliminado “/” symbol at the beginning of the URL. For the API |
La URL adjunta es: /gateways/{uuid}/storage/volumes
Al ejecutar la operación GET, la URL generada es la siguiente: GEThttps://<hostname\>/api/gateways/<cluster_UUID\>/storage/volumes
La /api etiqueta de la URL de REST de ONTAP se elimina en la URL anexada y la de la API de gateway se conserva.
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 de ese clúster. El formato de la respuesta es el mismo que recibes cuando ejecutas la misma API desde ONTAP. Los códigos de estado que se devuelven son los códigos de estado de REST de ONTAP.
Establecer el ámbito de la API
Todas las API tienen un contexto definido dentro del ámbito del clúster. Las API que operan sobre la base de máquinas virtuales de almacenamiento también tienen el clúster como ámbito, es decir, las operaciones de la API se realizan en una máquina virtual de almacenamiento concreta dentro de un clúster gestionado. Al ejecutar la /gateways/{uuid}/{path} API, asegúrate de introducir el UUID del clúster (UUID de la fuente de datos de Unified Manager) del clúster en el que ejecutas la operación. Para establecer el contexto en una máquina virtual de almacenamiento concreta dentro de ese clúster, introduce la clave de la máquina virtual de almacenamiento como parámetro X-Dot-SVM-UUID o el nombre de la máquina virtual de almacenamiento como parámetro X-Dot-SVM-Name. El parámetro se añade como filtro en el encabezado de la cadena y la operación se ejecuta dentro del ámbito 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 de REST de ONTAP, consulta "Automatización de la API de REST de ONTAP"