compute
GET /v1/compute/servers/{serverId}
Get one server, with the provider's live state merged in.
Ìfàṣẹ́pọ̀
Fi bọ́ọ̀lù (bearer token) ranṣẹ gẹ́gẹ́ bí kọ́kọ́rọ́ API. Kọ́kọ́rọ́ náà gbọ́dọ̀ ní ìyọ̀ǹda sites.view; a ó kọ̀ ọ́ silẹ pẹlu 403, kii ṣe 404, ti kọ́kọ́rọ́ náà kò bá ní i.
Ojú abánisọ̀rọ̀ yìí kò gba id ajọ kankan. Kọ́kọ́rọ́ rẹ ti mọ ajọ ti o jẹ ti e, a o si fèsì nipa rẹ̀.
Gbiyanju rẹ
Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.
curl -X GET https://api.zinndigital.com/v1/compute/servers/{serverId} \
-H "Authorization: Bearer zdk_live_…"Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API
Àwọn kúlẹ̀kúlẹ̀
One machine, refreshed against the provider. The refresh is best-effort and never fails the screen: the row is what we know, the merge is an improvement on it, and a 503 on a detail page would hide a server the customer owns. power_state has six values rather than two, and the four extra ones are the whole point — a machine mid-transition is not "on". A stopping server rendered as running with an enabled Stop button is a customer pressing Stop twice and filing a ticket, and an unread state rendered as "off" is worse: it invites a Start on a machine that is already running. unknown is the honest answer when the provider stated none and is never collapsed into off. A client polls on the three transitional values and on status: provisioning. 404 for a server that is not the caller's or does not exist — the tenancy boundary of this surface is our own rows, and out-of-scope and nonexistent give the same answer on purpose. Requires sites.view.
Àwọn ìpìlẹ̀
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
serverId (path) | Uuid | Bẹẹni | 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. |
Idahun
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
id | Uuid | Bẹẹni | Ours, and also the provisioning workflow's id and the machine's name at the provider — which is what makes the whole purchase path idempotent. |
name | string | Bẹẹni | What the customer called it. ⛔ At the provider a machine's name is its row id; confusing the two is a cross-tenant defect, so this is the customer's string and nothing else. |
deploy_target | string | Bẹẹni | Which compute range the machine belongs to. |
plan_code | string | Bẹẹni | The tier it was bought on, or "" when it was ordered by size alone. |
provider | string | Bẹẹni | Our provider id. |
spec | string | Bẹẹni | The machine size it currently runs. |
zone | string | Bẹẹni | The data centre it runs in. |
status | string<pending, provisioning, active, failed, suspended, terminated, resizing, terminating> | Bẹẹni | How far the order got — ours, and a different fact from power_state. pending is a row with nothing bought and nothing charged; failed is the state whose message is the… |
message | string | Bẹẹni | Why the order failed, in a sentence the customer reads. Blank unless failed. |
vendor_status | string | Bẹẹni | The provider's own word, verbatim and unrounded. Staff-facing detail; a customer client renders status and never this. |
power_state | string<unknown, on, off, starting, stopping, rebooting> | Bẹẹni | What the machine is doing right now. ⛔ Six values, not two, and the four extra ones are the point: a machine mid-transition is not "on". unknown is the honest answer when… |
addresses | string[] | Bẹẹni | Public addresses if the provider states them. Empty means not stated, never "none" — a machine rendered as having no address reads as broken. |
optimisation | string | Bẹẹni | The stack optimisation profile it was built with, or "" for none. |
term_months | integer | Bẹẹni | The term it was bought on, or null when the provider states none. |
renews_at | string | Bẹẹni | ⛔ Always null today, and honestly so: the provider publishes no renewal date, and one computed from the order plus the term would be our arithmetic rendered as the provider's… |
created_at | string | Bẹẹni | When the row was created, or "" when not stated. |
operable | boolean | Bẹẹni | Whether the customer may act on this machine — power, resize, renew, rebuild. ⛔ Read rather than re-derived from status: the engine refuses every one of those on anything but… |
image | string | Bẹẹni | The provider image the machine was built from. Blank on the resold range, which installs one managed image and offers no choice. |
suspended | boolean | Bẹẹni | ⛔⛔ Whether WE stopped it, which is not the same fact as power_state. A stopped machine is the customer's own choice and they may start it again; a suspended one is ours and… |
suspension_reason | string | Bẹẹni | Why, verbatim, so the customer reads the same sentence support wrote. Blank when the machine is in good standing. |
capabilities | string[] | Bẹẹni | ⭐⭐ What this machine's provider can actually do — capability tokens such as compute:snapshots, compute:console, compute:firewall, compute:backups_manage and… |
billing | ComputeServerBilling | Bẹẹni | How a machine is paid for (W43-47, docs/687). term machines are charged ahead by a per-machine subscription. metered machines are charged per started hour from the account… |
login_user | string | Bẹẹni | The account to sign in as (W43-49, docs/689). admin — key-only, passwordless sudo, root login refused — on a Zinn® Cloud machine built under the access model; root on one… |
blueprint | string<, docker, k3s, k3s_argocd> | Bẹẹni | The software stack installed at first boot. Blank for none. |
cluster_id | string | Bẹẹni | The cluster this machine is a node of, or blank. |
cluster_role | string<, server, agent> | Bẹẹni | — |
Awọn aṣiṣe ti ibudo ipari yii le da pada
401 · 403 · 404 · 422 · 429 · 503