compute
GET /v1/compute/servers/{serverId}/health
Read a server's hardware and live resource usage.
Autentifikimi
Drgoni një çelës API si një token mbajtës. Çelësi duhet të ketë lejen sites.view; një çelës pa të refuzohet me 403, jo 404.
Ky pikëndalim nuk pranon id të organizatës. Çelësi juaj tashmë identifikon organizatën së cilës i përket dhe përgjigjja kufizohet vetëm për atë.
Provoje
Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.
curl -X GET https://api.zinndigital.com/v1/compute/servers/{serverId}/health \
-H "Authorization: Bearer zdk_live_…"Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së
Detajet
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`.
Parametrat
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
serverId (path) | Uuid | Po | 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. |
Përgjigja
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
cores | integer | Po | Virtual CPU cores the machine is sold with. |
ram_mb | integer | Po | Memory the machine is sold with, in megabytes. |
disk_gb | integer | Po | Primary disk the machine is sold with, in gigabytes. |
os_name | string | Po | The provider's own name for the operating system image, or `""`. |
ram_used_bytes | integer | Po | Memory in use, in bytes. `null` when the provider did not say. |
ram_total_bytes | integer | Po | Total memory, in bytes. `null` when the provider did not say. |
disk_used_bytes | integer | Po | Disk in use, in bytes. `null` when the provider did not say. |
disk_total_bytes | integer | Po | Total disk, in bytes. `null` when the provider did not say. |
cpu_percent | number | Po | 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 | Po | This month's transfer, in gigabytes. `null` when not stated. |
bandwidth_allowance_gb | number | Po | 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 | Po | 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 | Po | The provider's own word for the machine's state (`running`, `shut off`), verbatim and never rounded to a boolean, or `""`. |
Gabimet që ky pikëndalim mund të kthejë
401 · 403 · 404 · 422 · 429 · 503