Ir a la documentación
DocumentaciónReferencia de la APIConsultar métricas del servidor
GETToken Bearer

Consultar métricas del servidor

/api/v1/servers/:id/metrics

Consulta las métricas almacenadas del servidor. latest es el informe más reciente; samples contiene puntos históricos con una estructura diferente.

Los nombres de campos, los tipos y el código de la API se mantienen iguales en todos los idiomas.

Ejemplo de petición

cURL
curl "https://tovahub.com/api/v1/servers/507f1f77bcf86cd799439012/metrics?period=24hr" \
  -H "Authorization: Bearer $TOVAHUB_TOKEN"

Solo ejemplos. Esta página no envía peticiones.

Respuesta ilustrativa
JSON
{
  "period": "24hr",
  "serverStatus": "running",
  "metrics": {
    "online": false,
    "reportingMode": 1,
    "reportInterval": 60,
    "lastReportedAt": null,
    "lastSampledAt": null,
    "bootChangedAt": null,
    "shutdownAt": null
  },
  "latest": null,
  "samples": []
}

Parámetros

idRuta · Obligatorio

string

ID del recurso: 24 caracteres hexadecimales. Use el ID de la plataforma devuelto por el endpoint de listado correspondiente, no el ID de instancia del proveedor.

periodConsulta · Opcional

"1hr" | "24hr" | "7d"

El valor predeterminado es 24hr.

Respuesta

Estado HTTP 200

Consulta las métricas guardadas del host, el informe más reciente y las muestras históricas.

periodstring ('1hr' | '24hr' | '7d')

Período histórico solicitado.

serverStatusstring

Estado guardado del servidor, normalizado.

metricsobject

Metadatos de actividad del monitoreo.

metrics.onlineboolean

Indica si los informes recientes muestran que el agente está en línea.

metrics.reportingModenumber

Modo de envío de informes configurado actualmente; el valor predeterminado es uno.

metrics.reportIntervalnumber

Intervalo esperado entre informes, en segundos.

metrics.lastReportedAtstring (ISO 8601) | null

Marca de tiempo de recepción del último informe.

metrics.lastSampledAtstring (ISO 8601) | null

Marca de tiempo de la última muestra.

metrics.bootChangedAtstring (ISO 8601) | null

Último cambio de arranque detectado.

metrics.shutdownAtstring (ISO 8601) | null

Último apagado notificado.

latestobject | null

Último informe guardado de métricas o apagado, o null si aún no hay informes. Sus campos difieren de los de las muestras históricas.

latest.version1

Versión del formato del informe.

latest.kind"metrics" | "shutdown"

Tipo de informe.

latest.bootIdstring (UUID)

Identificador del arranque informado.

latest.intervalnumber

Intervalo de muestreo en segundos, entre 5 y 300.

latest.uptimenumber

Tiempo de actividad en segundos.

latest.sampledAtnumber (optional)

Marca de tiempo de la muestra del cliente, en milisegundos desde la época Unix.

latest.cpunumber | null

Uso de CPU entre 0 y 100 por ciento, o null si no está disponible.

latest.memoryUsednumber

Memoria usada en bytes.

latest.memoryTotalnumber

Memoria total en bytes.

latest.swapUsednumber

Espacio de intercambio usado en bytes.

latest.swapTotalnumber

Espacio de intercambio total en bytes.

latest.diskReadnumber | null

Velocidad de lectura del disco en bytes por segundo.

latest.diskWritenumber | null

Velocidad de escritura del disco en bytes por segundo.

latest.netInnumber | null

Velocidad de recepción de red en bytes por segundo.

latest.netOutnumber | null

Velocidad de transmisión de red en bytes por segundo.

latest.disksobject[]

Hasta 32 discos montados con mount (cadena), total (bytes) y used (bytes).

samplesarray

Hasta 600 puntos históricos ordenados por tiempo. Los valores numéricos son promedios por intervalo; low y high conservan los mínimos y máximos de cada métrica.

samples[].atstring (ISO 8601)

Marca de tiempo de la muestra histórica.

samples[].cpunumber | null

Porcentaje de uso de CPU, o null si no está disponible.

samples[].memoryUsednumber | null

Capacidad en bytes, o null si no está disponible.

samples[].memoryTotalnumber | null

Capacidad en bytes, o null si no está disponible.

samples[].swapUsednumber | null

Capacidad en bytes, o null si no está disponible.

samples[].swapTotalnumber | null

Capacidad en bytes, o null si no está disponible.

samples[].diskReadnumber | null

Velocidad de transferencia en bytes por segundo, o null si no está disponible.

samples[].diskWritenumber | null

Velocidad de transferencia en bytes por segundo, o null si no está disponible.

samples[].netInnumber | null

Velocidad de transferencia en bytes por segundo, o null si no está disponible.

samples[].netOutnumber | null

Velocidad de transferencia en bytes por segundo, o null si no está disponible.

samples[].uptimenumber | null

Tiempo de actividad en segundos, o null si no está disponible.

samples[].disksarray

Discos montados: {mount: string, used: number, total: number}. Las capacidades se expresan en bytes.

samples[].lowobject

Valores mínimos por métrica, con los mismos diez nombres de métricas numéricas como claves.

samples[].highobject

Valores máximos por métrica, con los mismos diez nombres de métricas numéricas como claves.