compute
GET /v1/compute/servers/{serverId}/health
Read a server's hardware and live resource usage.
인증
Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 sites.view 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.
이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.
무료 체험하기
대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.
curl -X GET https://api.zinndigital.com/v1/compute/servers/{serverId}/health \
-H "Authorization: Bearer zdk_live_…"로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 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