compute
GET /v1/compute/servers/{serverId}/health
Read a server's hardware and live resource usage.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл sites.view; ключ без нього відхиляється з кодом 403, а не 404.
Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X GET https://api.zinndigital.com/v1/compute/servers/{serverId}/health \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
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`.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
serverId (path) | Uuid | Так | 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. |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
cores | integer | Так | Virtual CPU cores the machine is sold with. |
ram_mb | integer | Так | Memory the machine is sold with, in megabytes. |
disk_gb | integer | Так | Primary disk the machine is sold with, in gigabytes. |
os_name | string | Так | The provider's own name for the operating system image, or `""`. |
ram_used_bytes | integer | Так | Memory in use, in bytes. `null` when the provider did not say. |
ram_total_bytes | integer | Так | Total memory, in bytes. `null` when the provider did not say. |
disk_used_bytes | integer | Так | Disk in use, in bytes. `null` when the provider did not say. |
disk_total_bytes | integer | Так | Total disk, in bytes. `null` when the provider did not say. |
cpu_percent | number | Так | 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 | Так | This month's transfer, in gigabytes. `null` when not stated. |
bandwidth_allowance_gb | number | Так | 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 | Так | 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 | Так | The provider's own word for the machine's state (`running`, `shut off`), verbatim and never rounded to a boolean, or `""`. |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404 · 422 · 429 · 503