compute
GET /v1/compute/servers/{serverId}/health
Read a server's hardware and live resource usage.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز 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 class… |
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