compute
GET /v1/compute/servers/{serverId}/health
Read a server's hardware and live resource usage.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.view 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
此端点不需要组织 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