compute

GET /v1/compute/servers/{serverId}

Get one server, with the provider's live state merged in.

Wszystkie punkty końcowe compute

Wszystkie dokumentacje dla programistów

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie sites.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

curl -X GET https://api.zinndigital.com/v1/compute/servers/{serverId} \
  -H "Authorization: Bearer zdk_live_…"

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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.

Parametry

NazwaTypWymaganeCo to jest
serverId (path)UuidTakThe 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.

Odpowiedź

NazwaTypWymaganeCo to jest
idUuidTakOurs, and also the provisioning workflow's id and the machine's name at the provider — which is what makes the whole purchase path idempotent.
namestringTakWhat 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_targetstringTakWhich compute range the machine belongs to.
plan_codestringTakThe tier it was bought on, or "" when it was ordered by size alone.
providerstringTakOur provider id.
specstringTakThe machine size it currently runs.
zonestringTakThe data centre it runs in.
statusstring<pending, provisioning, active, failed, suspended, terminated, resizing, terminating>TakHow 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…
messagestringTakWhy the order failed, in a sentence the customer reads. Blank unless failed.
vendor_statusstringTakThe provider's own word, verbatim and unrounded. Staff-facing detail; a customer client renders status and never this.
power_statestring<unknown, on, off, starting, stopping, rebooting>TakWhat 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…
addressesstring[]TakPublic addresses if the provider states them. Empty means not stated, never "none" — a machine rendered as having no address reads as broken.
optimisationstringTakThe stack optimisation profile it was built with, or "" for none.
term_monthsintegerTakThe term it was bought on, or null when the provider states none.
renews_atstringTakAlways 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_atstringTakWhen the row was created, or "" when not stated.
operablebooleanTakWhether 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…
imagestringTakThe provider image the machine was built from. Blank on the resold range, which installs one managed image and offers no choice.
suspendedbooleanTak⛔⛔ 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_reasonstringTakWhy, verbatim, so the customer reads the same sentence support wrote. Blank when the machine is in good standing.
capabilitiesstring[]Tak⭐⭐ What this machine's provider can actually do — capability tokens such as compute:snapshots, compute:console, compute:firewall, compute:backups_manage and…
billingComputeServerBillingTakHow 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_userstringTakThe 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…
blueprintstring<, docker, k3s, k3s_argocd>TakThe software stack installed at first boot. Blank for none.
cluster_idstringTakThe cluster this machine is a node of, or blank.
cluster_rolestring<, server, agent>Tak

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 422 · 429 · 503