¶ APIs de orquestrador Soax
El orquestador Soax, desarrollado por Oasix, cuenta con una completa interfaz de gestión a través de APIs. Estas interfaces permiten integrar sus funcionalidades con otros sistemas, automatizar procesos y optimizar la administración de recursos de forma ágil y eficiente. A continuación en esta página, se detallan tanto las principales APIs disponibles como dónde consultar la documentación sobre ellas, asi como casos de uso y ejemplos comunes a modo de introducción.
¶ Acciones basadas en APIs
Para comprender realmente la importancia de esta funcionalidad, previamente se ha de comprender en que situaciones podemos hacer uso de ella y qué tipos de acciones estan disponibles. Por ello, se detallan algunas de las acciones realizadas mediante las APIs:
¶ Keystone (RBAC)
En esta sección, se pueden realizar acciones como las sigueintes:
- Autenticación y gestión de credenciales (obtención de tokens, creación y administración de accesos).
- Gestión de dominios y proyectos (visualización, administración y organización).
- Usuarios, roles y políticas (definición, interacción y control de permisos).
Puede comprobar las sigueintes documentaciones sobre Keystone Soax API:
¶ Neutron (Conectividad)
En esta sección se pueden gestionar diferentes recursos:
- Redes e infraestructura (gestión de redes, subredes, puertos, trunks VLAN, routers, BGP, peers, VPNs, pools, IPs flotantes y redirecciones).
- Seguridad y control (grupos de seguridad, reglas, políticas de firewall, RBAC y QoS).
- Recursos y monitoreo (sabores, quotas, logs y visualización de reglas QoS).
Puede comprobar las sigueintes documentaciones sobre Neutron Soax API:
¶ Nova (Computación)
En esta sección se pueden revisar diferentes acciones:
- Infraestructura y recursos (agregados de host, hipervisores, sabores y quotas).
- Gestión de servidores y acceso (detalles de servidores y pares de claves).
Puede comprobar las sigueintes documentaciones sobre Nova Soax API:
¶ Cinder (Almacenamiento)
En esta sección se pueden revisar diferentes acciones:
- Almacenamiento y copias (volúmenes, snapshots y backups).
- Configuración y control (tipos de volúmenes, quotas y QoS).
Puede comprobar las sigueintes documentaciones sobre ** Soax API**:
¶ Visualizar API Rest en Soax
En Soax existe una sección donde se muestra el listado de endpoints disponibles y la documentación asociada a cada API Rest separado por módulos, facilitando su exploración y utilización.
Para poder visualizar el listado de modulos, con sus respectivos endpoints y documentaciones desde Soax, debemos pulsar sobre el nombre de nuestro usuario en la esquina superior derecha de la ventana y seleccionar la opciónd de API REST.
Una vez realizado este procedimiento, podremos ver todas la información sobre enlaces de interés tanto de modulos internos de Openstack como de otros servicios de Oasix como BaaS Premium (Commvault) o la plataforma de Tickets para consultas o incidencias.
¶ Visualizar Token de sesión en Soax
Para obtener el token de inicio de sesión para el uso de las API desde Soax, tendremos que seleccionar en la parte superior derecha de la pantalla nuestro nombre y hacer clic para lanzar el desplegable:
Una vez desplegadas las opciones, seleccionaremos la opción Identidad. Una vez accedemos al apartado de identidad podremos observar distintos datos de nuestro usuario actual, pero nos centraremos en el recuadro que especifica "Token" y haremos clic en el ojo para así visualizar nuestro Token de usuario para su uso en APIs.
De esta manera ya tendremos nuestro Token de usuario listo para copiar y usarlo en nuestro entorno de conexión para las APIs:
¶ Casos de uso
El acceso mediante API en la nube pública de Soax ofrece a los clientes una forma flexible y automatizada de interactuar con sus entornos y recursos. Las APIs de Soax permiten integrar la gestión de la infraestructura directamente en aplicaciones, pipelines o sistemas, facilitando la automatización, la eficiencia y la escalabilidad. Esto habilita múltiples escenarios prácticos como los siguientes:
- Automatización de despliegues: creación de servidores, redes y volúmenes sin intervención manual.
- Integración con CI/CD: provisión y destrucción de entornos de prueba o producción desde pipelines.
- Escalado dinámico: ajuste de recursos en función de la demanda.
- Gestión de redes: configuración de VPNs, reglas de seguridad, balanceadores e IPs flotantes.
- Optimización de costos: consulta de consumos y liberación de recursos no utilizados.
- Autoservicio de usuarios: gestión de proyectos y credenciales bajo políticas definidas.
- Respaldo y recuperación: snapshots y backups programados para garantizar continuidad de negocio.
- Cumplimiento y auditoría: acceso a logs, trazas y aplicación de políticas de seguridad.
¶ Ejemplos
En este caso, utilizaremos una api específica para obtener un token de autenticación.
Se pueden utilizar diferentes métodos de autenticación como los siguientes:
- Autenticación Multi-Step (ejemplo con 2 factores: contraseña y TOTP)
- Autenticación con un Application Credentials.
En este caso, se va a explicar cómo realizar la autenticación via API usando la primera opción.
Puede consultar toda la información sobre Application Credentials en el siguiente enlace:
- Método / URL
POST {{platform_url}}/auth/tokens
- Petición
A continuación, se muestran todos los parámentros relacionados con esta acción.
| NAME | In | Type | Descripción |
|---|---|---|---|
| nocatalog (Opcional) | query | string | La respuesta de autenticación excluye el catálogo de servicios. Por defecto, la respuesta incluye el catálogo de servicios. |
| auth | body | object | Un objeto de autenticación. |
| identity | body | object | Un objeto de identidad. Debe estar contenido en el objeto auth. |
| methods | body | array | Los métodos de autenticación. Para autenticación por contraseña, especificar "password". Para autenticación TOTP, especificar "totp". En esta solicitud, ambos métodos deben ser especificados. |
| totp | body | object | Un objeto totp. Debe estar contenido en el objeto identity. Contiene los parámetros TOTP necesarios para realizar esta solicitud. |
| password | body | object | El objeto password, contiene la información de autenticación. Debe estar contenido en el objeto identity. |
| user | body | object | Un objeto user. Debe estar contenido en los objetos totp y password. |
| user.id (Opcional) | body | string | El ID del usuario. Requerido si no se especifica el nombre de usuario. |
| user.name (Opcional) | body | string | El nombre del usuario. Requerido si no se especifica el ID del usuario. |
| user.passcode | body | string | El código para validar la solicitud TOTP. |
| user.password | body | string | La contraseña para autenticar la solicitud del usuario. |
| scope | body | object | Un objeto scope. Debe estar contenido en el objeto auth. Contiene el alcance (proyecto, dominio,...) de la solicitud. |
| scope.id | body | string | El ID de la entidad según el scope (proyecto, dominio,...). |
- Ejemplo
Para realizar la petición utilizamos:
https://{{platform_URL}}/auth/tokens
Indicando un body como el siguiente:
Como respuesta se obtiene el token en la cabecera y los sigueintes detalles como body:
Una vez se obtiene el token, se podrá utilizar para autenticar al realizar el resto de llamadas de API en Soax.
En este caso, utilizaremos una api específica para obtener las trazas (de acción o de seguridad) de Soax.
En este caso, se pueden incluir diferentes parámetros para filtrar la obtención de trazas. Si no se filtra (ningún parámetro especificado), se obtienen las trazas de acción del día actual, y todas las trazas que el rol del usuario permita visualizar.
- Método / URL
POST {{platform_url}}/Wotan/api/traces
- Petición
Todos los parámetros para esta petición son opcionales menos el token para realizar la autenticación.
| NAME | In | Type | Description |
|---|---|---|---|
| token * | header | string | A valid OpenStack token |
| domain | URL | string | Domain name requested to get its traces |
| project | URL | string | Project name requested to get its traces |
| user | URL | string | Username requested to get its traces |
| type | URL | string | Type of traces requested. If not specified, the default value is "action" |
| start_date | URL | string | Date from which traces are going to be obtained. If not specified, the default value is the current day |
| end_date | URL | string | Date up to which traces are going to be obtained. If not specified, the default value is the current day |
| contains | URL | string | A text that can be specified to filter the traces that have this text. Default is empty string |
- Ejemplo
Para realizar la petición utilizamos:
https://{{platform_URL}}/Wotan/api/traces?type=action&start_date=2022-11-02
Como respuesta se obtiene un contenido similar al siguiente:
| NAME | In | Type | Description |
|---|---|---|---|
| traces | body | string | Traces according to given parameters |
Inicialización a las APIs de soax
como usar las APIs de Soax
API soax
Como consultar la API de Soax