Módulo 8 del curso de Dynatrace Managed: automatización con API, API de entorno y API Cluster, para pasar de los ajustes manuales a los scripts y a la configuración as code.
Curso: Dynatrace Managed · Módulo 8/8 · Duración: ~75 min · Nivel: Avanzado
Objetivos:
- Distinguir la API de entorno y la API Cluster, y saber cuál usar.
- Crear un token de API con el ámbito mínimo y hacer las primeras llamadas.
- Leer entidades, métricas y problemas desde un script.
- Entender el enfoque de configuración as code y sus herramientas.
Requisitos previos: módulos 1 a 7, un entorno Managed de pruebas, permisos para crear tokens de API, un equipo con curl y jq, y nociones de JSON y de Git.
Todo lo que has configurado a mano durante este curso (tags, management zones, perfiles de alerta, entornos) se puede crear, leer y controlar por programa. Este último módulo del curso de Dynatrace Managed está dedicado a la automatización con API en Managed: las dos familias de API, los tokens, los primeros scripts y, después, el paso a la configuración as code para versionar tus ajustes como código de aplicación.
Continúa directamente el módulo 7, cuyos controles de operación son buenos candidatos para la automatización. El índice del curso recapitula todos los módulos.
¿Qué API usar para la automatización con API en Managed?
Un despliegue Managed expone dos familias de API, con direcciones y tokens distintos:
| API | Dirección base | Uso |
|---|---|---|
| API de entorno (v1 y v2) | https://{votre-domaine}/e/{id-environnement}/api/… |
Datos y configuración de un entorno: entidades, métricas, problemas, ajustes, tokens |
| API Cluster (v1 y v2) | https://{votre-domaine}/api/cluster/… |
Administración del clúster: entornos, nodos, usuarios y grupos, cuotas |
Regla sencilla: si la tarea afecta a lo que se monitoriza, usa la API de entorno; si afecta a la propia plataforma, usa la API Cluster. Los tokens de una no funcionan en la otra.
Crear un token de API con el ámbito justo
Los tokens de entorno se crean en los ajustes del entorno y los tokens de clúster en la CMC. En ambos casos, marca únicamente los permisos (scopes) necesarios, dale al token un nombre explícito («audit-lecture», «pipeline-config-recette») y guárdalo en un gestor de secretos, nunca en un repositorio Git. El token se transmite en la cabecera HTTP:
Authorization: Api-Token {votre-jeton}
Para las primeras llamadas de este módulo basta un token de entorno de solo lectura, con los permisos de lectura de entidades, métricas, problemas y ajustes. Los nombres exactos figuran en la pantalla de creación del token.
Leer datos con la API de entorno
Algunas llamadas útiles, que debes adaptar a tu dominio y a tu identificador de entorno:
export DT_URL="https://{votre-domaine}/e/{id-environnement}"
export DT_TOKEN="..." # à charger depuis votre coffre de secrets
# Lister les hôtes supervisés
curl -s -H "Authorization: Api-Token $DT_TOKEN" \
"$DT_URL/api/v2/entities?entitySelector=type(%22HOST%22)" | jq '.entities[].displayName'
# Lister les problèmes ouverts ou récents
curl -s -H "Authorization: Api-Token $DT_TOKEN" \
"$DT_URL/api/v2/problems" | jq '.problems[] | {title, severityLevel, status}'
# Interroger une métrique
curl -s -H "Authorization: Api-Token $DT_TOKEN" \
"$DT_URL/api/v2/metrics/query?metricSelector=builtin:host.cpu.usage&from=now-2h"
Las respuestas voluminosas están paginadas: sigue la clave de página siguiente que devuelve la API hasta agotarla. Comprueba también el código HTTP de cada llamada en tus scripts: un 401 o un 403 señala casi siempre un token no válido o un permiso ausente.
Administrar con la API Cluster
La API Cluster sirve sobre todo para industrializar la creación de entornos, la gestión de grupos y el control del estado de los nodos antes de un mantenimiento. Una primera llamada típica consiste en listar los entornos:
curl -s -H "Authorization: Api-Token $CLUSTER_TOKEN" \
"https://{votre-domaine}/api/cluster/v2/environments" | jq
Escribe tus scripts de forma idempotente: se comprueba si el objeto existe antes de crearlo, para poder relanzar el script sin efectos secundarios. El artículo Automatizar la administración con la API Cluster de Dynatrace Managed desarrolla varios escenarios completos.
Pasar a la configuración as code
Las llamadas individuales muestran enseguida sus límites: hay que gestionar el orden de creación, las dependencias (un perfil de alerta que hace referencia a una management zone) y la promoción de un entorno a otro. La configuración as code responde a estas necesidades: la configuración se describe en archivos versionados, revisados en una revisión de código y aplicados por una herramienta.
| Herramienta | Principio | Cuándo elegirla |
|---|---|---|
| Monaco (Dynatrace Configuration as Code) | CLI de código abierto mantenida por Dynatrace, configuraciones en YAML y JSON, despliegue en uno o varios entornos | Equipos que quieren una herramienta dedicada a Dynatrace |
| Proveedor Terraform de Dynatrace | Recursos de Terraform para la configuración de Dynatrace | Organizaciones que ya trabajan con Terraform |
| Scripts propios | Llamadas directas a la API | Necesidades puntuales o muy específicas |
Antes de elegir, comprueba en la documentación de cada herramienta su compatibilidad con tu versión de Managed y los tipos de configuración que admite. En todos los casos, el esquema objetivo es el mismo: repositorio Git, revisión y un pipeline que aplica primero en pruebas y después en producción.
depot-config-dynatrace/
├── recette/
│ ├── management-zones/
│ ├── auto-tagging/
│ └── alerting-profiles/
└── prod/
└── ...
Para los tags y las zonas, el artículo Management zones y tagging automático muestra cómo crearlos mediante la API de ajustes.
Ejercicio práctico
Paso 1 — Crear un token de solo lectura
En tu entorno de pruebas, crea un token llamado formation-lecture con únicamente permisos de lectura (entidades, métricas, problemas).
Resultado esperado: un token que se muestra una sola vez y que guardas en tu gestor de secretos.
Paso 2 — Listar los hosts
Ejecuta la llamada entities anterior.
Resultado esperado: la lista de nombres de host, idéntica a la de la interfaz.
Paso 3 — Producir un informe de problemas
Adapta la llamada problems para generar un archivo CSV (título, severidad, estado) con jq -r.
Resultado esperado: un archivo legible en una hoja de cálculo, que podrías enviar cada lunes.
Paso 4 — Verificar los permisos
Intenta una escritura (por ejemplo, la creación de un ajuste) con ese mismo token.
Resultado esperado: un rechazo (código 403), prueba de que el ámbito del token está bien limitado.
Paso 5 — Exportar una configuración
Con Monaco o el proveedor de Terraform, siguiendo su documentación, exporta las management zones del entorno de pruebas a un repositorio Git local.
Resultado esperado: archivos que describen tus zonas, listos para revisarse y volver a aplicarse.
Cuestionario
- ¿Qué API usas para crear un nuevo entorno?
A. La API de entorno · B. La API Cluster · C. La API de OneAgent - ¿Cómo se transmite el token en una llamada?
A. En la cabeceraAuthorization: Api-Token …· B. En el nombre de dominio · C. En una cookie de sesión de la interfaz - Un script recibe un código 403. ¿Cuál es la causa más probable?
A. El clúster está apagado · B. El token no tiene el permiso requerido · C. La métrica no existe - ¿Cuál es la principal aportación de la configuración as code?
A. Sustituye a la monitorización · B. Versiona, revisa y reproduce la configuración de forma repetible · C. Elimina la necesidad de tokens
Soluciones
- B. La creación de entornos forma parte de la administración del clúster.
- A. La cabecera
Authorizationcon el prefijoApi-Tokenlleva el token. - B. Un 403 señala un acceso denegado, casi siempre un permiso ausente en el token.
- B. Los archivos versionados hacen cada cambio trazable y reproducible de un entorno a otro.
Para ir más lejos
- Automatizar la administración con la API Cluster de Dynatrace Managed
- Gestionar varios entornos y cuotas de licencia en la CMC
- Management zones y tagging automático: estructurar un entorno compartido
- Documentación oficial de Dynatrace Managed: docs.dynatrace.com/managed (secciones sobre la API de entorno, la API Cluster y la configuración as code)
← Módulo 7: operar el clúster · Índice del curso →
Preguntas frecuentes
¿Hay que preferir la API v2 a la v1?
Para los scripts nuevos, sí cuando existe el equivalente en v2. Algunas operaciones de configuración siguen disponibles solo en v1 según la versión: comprueba la documentación de tu versión.
¿Se puede usar el mismo token para todo?
No es aconsejable. Un token por uso, con el ámbito mínimo, limita el impacto de una fuga y facilita la rotación.
¿Funcionan en SaaS los scripts escritos para Managed?
Una parte de las API de entorno es común, pero la plataforma SaaS de última generación ofrece otros mecanismos y no tiene API Cluster. El curso de Dynatrace SaaS los presenta por separado.
Este módulo cierra el curso: ya sabes instalar, desplegar, explorar, alertar, organizar, operar y automatizar un entorno de Dynatrace Managed. Vuelve al índice para repasar un módulo o preparar una certificación oficial.
span.observer es un blog independiente de la comunidad, no afiliado a Dynatrace LLC. Este curso no sustituye a las formaciones y certificaciones oficiales de Dynatrace University. Comprueba siempre las funcionalidades en la documentación oficial correspondiente a tu versión.