compute

POST /v1/compute/servers

Order a server.

Všechny koncové body compute

Všechny dokumenty pro vývojáře

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění sites.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Sem patří ID vaší organizace

Tento koncový bod přijímá org_id jako pole v těle JSON.

ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

curl -X POST https://api.zinndigital.com/v1/compute/servers \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "zone": <string> }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

Buys a machine. 202 and the pending server: the purchase is durable and runs off the request path as a Temporal workflow (§2.9), so the client polls the returned server until status leaves provisioning. ⛔ The row is written first and the workflow started second. The reverse would mean a workflow whose row does not exist yet, and its first activity would fail on a race it can never win. The row's id is also the workflow id and the machine's name at the provider, which is what makes the whole path idempotent. If the workflow service cannot be reached the order is refused 503 with nothing charged — an acceptance is never fabricated, because the customer would watch a spinner for a server that was never ordered and then order it again. Send either spec or plan_code; neither is 422, not a 500. org_id is required only of a caller who belongs to more than one organisation, and naming one they cannot create in is 403. A size, zone or disk/bandwidth pair the provider does not offer, or a name already taken, is 422 in our wording. Requires sites.view and billing.entitlement.manage — ⛔ not sites.create, which is what this was until #1682. Ordering a machine charges Zinn®'s reseller balance immediately and bills nobody, so it is deliberately a STAFF key; sites.create is held by the customer dev role.

Tělo požadavku

NázevTypPožadovánoCo to je
namestringAnoWhat to call the machine. It is also the name at the provider, which is what lets a retried purchase find the machine it already bought instead of buying a second.
zonestringAnoThe data centre, as getComputeCatalogue reported it.
specstringNeThe machine size, as the configurator reported it. ⭐ Either this or plan_code, not both — and where the provider publishes no sizes the two collapse into one, because the…
plan_codestringNeThe tier to buy, for a catalogue-aware caller. Either this or spec.
org_idUuidNeThe organisation to buy for. Required only when the caller belongs to more than one — picking "the first org in scope" would buy a server on an arbitrary tenant's balance.…
providerstringNeWhich platform to place it on. Omitted, the engine resolves the range's default — ⛔ except on a range priced per data centre (ComputeTier.zoned), where omitting it is…
imagestringNeThe operating system or one-click application the machine boots, as getComputeCatalogue reported it in ComputeProvider.images. ⛔ Required — 422 — on any range that publishes…
ssh_keysstring[]NeThe ids of the authorised keys to install at build time, from listComputeSshKeys. ⛔⛔…
term_monthsintegerNeHow many months to buy up front. Outside 1…36 is refused 422 before a single vendor write, the same bound renewComputeServer applies.
optimisationstringNeA stack optimisation profile, as the configurator reported it.
diskstringNeAn explicit disk allocation, for a provider whose supports_disk_and_bandwidth is true. Sending it to one whose is false is refused.
bandwidthstringNeAn explicit transfer allocation, for a provider whose supports_disk_and_bandwidth is true.

Odpověď

NázevTypPožadovánoCo to je
idUuidAnoOurs, and also the provisioning workflow's id and the machine's name at the provider — which is what makes the whole purchase path idempotent.
namestringAnoWhat 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_targetstringAnoWhich compute range the machine belongs to.
plan_codestringAnoThe tier it was bought on, or "" when it was ordered by size alone.
providerstringAnoOur provider id.
specstringAnoThe machine size it currently runs.
zonestringAnoThe data centre it runs in.
statusstring<pending, provisioning, active, failed, suspended, terminated, resizing, terminating>AnoHow 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…
messagestringAnoWhy the order failed, in a sentence the customer reads. Blank unless failed.
vendor_statusstringAnoThe 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>AnoWhat 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[]AnoPublic addresses if the provider states them. Empty means not stated, never "none" — a machine rendered as having no address reads as broken.
optimisationstringAnoThe stack optimisation profile it was built with, or "" for none.
term_monthsintegerAnoThe term it was bought on, or null when the provider states none.
renews_atstringAnoAlways 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_atstringAnoWhen the row was created, or "" when not stated.
operablebooleanAnoWhether 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…
imagestringAnoThe provider image the machine was built from. Blank on the resold range, which installs one managed image and offers no choice.
suspendedbooleanAno⛔⛔ 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_reasonstringAnoWhy, verbatim, so the customer reads the same sentence support wrote. Blank when the machine is in good standing.
capabilitiesstring[]Ano⭐⭐ What this machine's provider can actually do — capability tokens such as compute:snapshots, compute:console, compute:firewall, compute:backups_manage and…
billingComputeServerBillingAnoHow 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…

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422 · 429 · 503