compute
GET /v1/compute/servers/{serverId}/health
Read a server's hardware and live resource usage.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation sites.view ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/compute/servers/{serverId}/health \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
What the machine is made of - cores, memory, disk, operating system - and how hard it is working right now: CPU, memory, disk and this month's bandwidth. Read live from the provider on every call and never stored, for the same reason the renewal is: a cached CPU reading is stale the moment it is written, and a customer looking at a usage gauge is asking about now. Every usage figure is `-1` when the provider did not answer, which is **not** the same as zero. A client must render the difference: `0%` says the machine is idle, `-1` says we could not ask. Memory and disk are byte counts with both halves of the ratio, so a screen can say "224 MB of 1 GB" rather than only a percentage. `power_state` is the provider's own word (`running`, `shut off`), carried verbatim and never rounded to a boolean. This response deliberately carries **no hostname**. The provider also states the guest hostname and the physical KVM host; both name our supplier and are never exposed to a customer. Requires `sites.view`.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
serverId (path) | Uuid | Oui | The server's id, as `listComputeServers` reports it. **Ours** (UUIDv7), minted when the order row was written — never the provider's own identifier for the machine. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
cores | integer | Oui | Virtual CPU cores the machine is sold with. |
ram_mb | integer | Oui | Memory the machine is sold with, in megabytes. |
disk_gb | integer | Oui | Primary disk the machine is sold with, in gigabytes. |
os_name | string | Oui | The provider's own name for the operating system image, or `""`. |
ram_used_bytes | integer | Oui | Memory in use, in bytes. `null` when the provider did not say. |
ram_total_bytes | integer | Oui | Total memory, in bytes. `null` when the provider did not say. |
disk_used_bytes | integer | Oui | Disk in use, in bytes. `null` when the provider did not say. |
disk_total_bytes | integer | Oui | Total disk, in bytes. `null` when the provider did not say. |
cpu_percent | number | Oui | Processor in use, 0-100. `null` when the provider did not say. ⛔ **Normalised to a real percentage at the boundary, on every range.** One provider reports every non-idle CPU cla… |
bandwidth_used_gb | number | Oui | This month's transfer, in gigabytes. `null` when not stated. |
bandwidth_allowance_gb | number | Oui | The monthly transfer allowance, in gigabytes. ⭐ **The one field on this schema that may be `-1`**, meaning the allowance has no ceiling; `null` means the provider did not state… |
bandwidth_overage_gb | number | Oui | Transfer used beyond the allowance this month, in gigabytes, as the provider states it — the figure overage charges are computed from. `null` when not stated, and a client must… |
power_state | string | Oui | The provider's own word for the machine's state (`running`, `shut off`), verbatim and never rounded to a boolean, or `""`. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 422 · 429 · 503