Para obtener la información más reciente sobre la API, inicie sesión en Cloud Insights y vaya a Admin > API access. Haga clic en el enlace Documentación de API.

La documentación de API es basada en Swagger, que proporciona una descripción breve e información de uso de la API, y permite probarlo en su entorno. Según la función de usuario y/o la edición Cloud Insights, los tipos de API disponibles para usted pueden variar.

Antes de utilizar la API de Cloud Insights, debe crear uno o más tokens de acceso de API. Los tokens de acceso se utilizan para los tipos de API especificados y pueden otorgar permisos de lectura y/o escritura. También puede establecer la caducidad de cada token de acceso. Todas las API de los tipos especificados son válidas para el token de acceso. Cada token es nulo de un nombre de usuario o contraseña.

Para crear un token de acceso:

Puede desactivar, activar y revocar tokens. Se pueden activar los tokens desactivados.

Los tokens conceden acceso de uso general a las API desde la perspectiva del cliente; además, gestionan el acceso a las API en el ámbito de su propio inquilino. Los administradores del cliente pueden conceder y revocar estos tokens sin la intervención directa del personal de administración de Cloud Insights.

La aplicación recibe un token de acceso después de que un usuario autentica correctamente y autoriza el acceso, a continuación, pasa el token de acceso como credencial cuando llama a la API de destino. El token pasado informa a la API de que el portador del token ha sido autorizado para acceder a la API y realizar acciones específicas especificadas por el ámbito que se concedió durante la autorización.

El encabezado HTTP donde se pasa el token de acceso es X-CloudInsights-ApiKey:.

Por ejemplo, utilice lo siguiente para recuperar activos de almacenamientos:

Consulte las páginas de Swagger para ver ejemplos específicos de la API que desea utilizar.

La API de Cloud Insights está basada en categorías y actualmente contiene los siguientes tipos:

Es posible que haya disponibles más tipos y/o API a lo largo del tiempo. Puede encontrar la información de API más reciente en el "Documentación de API Swagger".

Tenga en cuenta que los tipos de API a los que tiene acceso un usuario también dependen de "Rol de usuario" Se incluyen en cada conjunto de funciones de Cloud Insights (Supervisión, seguridad de carga de trabajo, generación de informes).

En esta sección se describe cómo recorrer una jerarquía de objetos Cloud Insights.

Muchos comandos de API admiten el parámetro Expand, que proporciona detalles adicionales sobre el objeto o las direcciones URL de los objetos relacionados.

El único parámetro de expansión común es expands. La respuesta contiene una lista de todas las expansi- do específicas disponibles para el objeto.

Por ejemplo, cuando solicite lo siguiente:

Cada expansión contiene datos, una URL o ambos. El parámetro expand admite varios atributos anidados, por ejemplo:

Para desalentarlo, las solicitudes de cobranzas de nivel superior no se pueden expandir. Por ejemplo, no puede solicitar la expansión de los datos de todos los objetos de almacenamiento al mismo tiempo. Los clientes deben recuperar la lista de objetos y, a continuación, elegir objetos específicos para expandirse.

Los datos de rendimiento se recopilan en muchos dispositivos como muestras independientes. Cada hora (valor predeterminado), Cloud Insights agrega y resume muestras de rendimiento.

La API permite el acceso tanto a las muestras como a los datos resumidos. Para un objeto con datos de rendimiento, hay disponible un resumen de rendimiento como Expand=Performance. Las series de tiempo del historial de rendimiento están disponibles mediante el Expand=performance.history anidado.

Algunos ejemplos de objetos de datos de rendimiento son:

Una métrica de rendimiento tiene una descripción y un tipo y contiene una colección de resúmenes de rendimiento. Por ejemplo, latencia, tráfico y velocidad.

Un resumen de rendimiento contiene una descripción, unidad, hora de inicio de la muestra, hora de finalización de la muestra y una recopilación de valores resumidos (actual, mín., máx., promedio, etc.) calculados a partir de un único contador de rendimiento en un intervalo de tiempo (1 hora, 24 horas, 3 días, etc.).

El diccionario de datos de rendimiento resultante tiene las siguientes claves:

Cada tipo de objeto de datos de rendimiento tiene un conjunto único de métricas de rendimiento. Por ejemplo, el objeto de rendimiento de máquina virtual admite “diskThroughput” como métrica de rendimiento. Cada métrica de rendimiento admitida es de una cierta “performanceCategory” presentada en el diccionario de métricas. Cloud Insights admite varios tipos de métrica de rendimiento enumerados más adelante en este documento. Cada diccionario de métrica de rendimiento también tendrá el campo “descripción” que es una descripción legible por el usuario de esta métrica de rendimiento y un conjunto de entradas de contador de resumen de rendimiento.

El contador de resumen de rendimiento es el resumen de contadores de rendimiento. Presenta valores agregados típicos como min, max y avg para un contador y también el último valor observado, intervalo de tiempo para datos resumidos, tipo de unidad para contador y umbrales para datos. Sólo los umbrales son opcionales; el resto de atributos son obligatorios.

Hay resúmenes de rendimiento disponibles para estos tipos de contadores:

La API puede mostrar métricas detalladas de los objetos de su entorno, por ejemplo:

Consulte "Documentación de API Swagger" para obtener información sobre las métricas de cada tipo de objeto.

Los datos del historial se presentan en los datos de rendimiento como una lista de parejas de mapas de Marca de tiempo y de contadores.

El nombre de los contadores de historial se basa en el nombre del objeto de métrica de rendimiento. Por ejemplo, el objeto de rendimiento de máquina virtual admite “diskThroughput”, de modo que el mapa de historia contendrá claves denominadas “diskThroughput.read”, “diskThroughput.write” y “diskThroughput.total”.

Lo siguiente es un ejemplo de JSON de datos de rendimiento para un disco:

Los objetos con atributos de capacidad utilizan tipos de datos básicos y la capacidadItem para la representación.

La API de búsqueda es un punto de entrada sencillo al sistema. El único parámetro de entrada a la API es una cadena de forma libre y el JSON resultante contiene una lista clasificada de resultados. Los tipos son los diferentes tipos de activos del inventario, como los almacenamientos, hosts, almacenes de datos, etc. Cada tipo contiene una lista de objetos del tipo que coinciden con los criterios de búsqueda.

Cloud Insights es una solución ampliable (abierta) que permite integraciones con sistemas de orquestación, gestión comercial, control de cambios y emisión de tickets de terceros, e integraciones personalizadas de CMDB.

La API RESTful de Cloud Insight es un punto principal de integración que permite un movimiento de datos sencillo y efectivo. Además, permite a los usuarios obtener un acceso sencillo a sus datos.

Para desactivar temporalmente un token de API, en la página de lista de tokens de API, haga clic en el menú "tres puntos" de la API y seleccione Disable. Puede volver a activar el token en cualquier momento utilizando el mismo menú y seleccionando Enable.

Para eliminar permanentemente un token de API, en el menú, seleccione "revocar". No puede volver a habilitar un token revocado; debe crear un nuevo token.

Los tokens de acceso a la API tienen una fecha de caducidad. Cuando caduca un token de acceso a la API, los usuarios deben generar un nuevo token (de tipo Data ingestión con permisos de lectura/escritura) y reconfigurar Telegraf para utilizar el token recién generado en lugar del token caducado. Los siguientes pasos detallan cómo hacer esto.