SystemStatus

Estrutura de dados do contrato OpenAPI.

Estrutura de dados do contrato OpenAPI.

Campos

CampoTipoPresençaDescrição
databaseobjectobrigatórioModelo: SystemStatusDatabase.
hostobjectobrigatórioModelo: HostHealthResult.
processobjectobrigatórioProcesso Go/API: heap e runtimeSys não são RAM usada da VPS; gomaxprocs não mede núcleos físicos nem CPU do host. Modelo: SystemStatusProcess.
sampledAtstringobrigatórioInstante UTC da amostragem do worker. O host tem sampledAt e idade próprios. Formato: date-time
schemaVersionintegerobrigatórioValor fixo: 1. Mínimo: 0
statusstringobrigatórioHTTP 200 significa que o observador respondeu. Verificar available/status em cada bloco; valores indisponíveis não representam consumo zero. Valores: "ok", "degraded"
versionstringopcional—
workerIdstringobrigatórioPadrão de formato: ^[A-Za-z0-9][A-Za-z0-9_.-]{0,127}$
workloadobjectobrigatórioModelo: SystemStatusWorkload.

Definição OpenAPI

json
{
  "additionalProperties": true,
  "properties": {
    "database": {
      "$ref": "#/components/schemas/SystemStatusDatabase"
    },
    "host": {
      "$ref": "#/components/schemas/HostHealthResult"
    },
    "process": {
      "$ref": "#/components/schemas/SystemStatusProcess",
      "description": "Processo Go/API: heap e runtimeSys não são RAM usada da VPS; gomaxprocs não mede núcleos físicos nem CPU do host."
    },
    "sampledAt": {
      "description": "Instante UTC da amostragem do worker. O host tem sampledAt e idade próprios.",
      "format": "date-time",
      "type": "string"
    },
    "schemaVersion": {
      "const": 1,
      "minimum": 0,
      "type": "integer"
    },
    "status": {
      "description": "HTTP 200 significa que o observador respondeu. Verificar available/status em cada bloco; valores indisponíveis não representam consumo zero.",
      "enum": [
        "ok",
        "degraded"
      ],
      "type": "string"
    },
    "version": {
      "type": "string"
    },
    "workerId": {
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,127}$",
      "type": "string"
    },
    "workload": {
      "$ref": "#/components/schemas/SystemStatusWorkload"
    }
  },
  "required": [
    "schemaVersion",
    "sampledAt",
    "status",
    "workerId",
    "process",
    "database",
    "workload",
    "host"
  ],
  "type": "object"
}