compute
GET /v1/compute/servers/{serverId}/health
Read a server's hardware and live resource usage.
認証
ベアラー トークンとして 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 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