compute
POST /v1/compute/servers
Order a server.
Πισtoποίηση
Στείλτε ένα κλειδί API ως διακριτικό φορέα (bearer token). Το κλειδί πρέπει να διαθέτει το δικαίωμα sites.view· ένα κλειδί που δεν το διαθέτει απορρίπτεται με 403, όχι 404.
Πού μπαίνει το αναγνωριστικό του οργανισμού σας
Αυτό το endpoint δέχεται το πεδίο org_id στο σώμα JSON.
Το αναγνωριστικό του οργανισμού σας βρίσκεται στην οθόνη των κλειδιών API στον πίνακα ελέγχου σας, δίπλα στο ίδιο το κλειδί. Είναι το ίδιο αναγνωριστικό σε κάθε κλήση που πραγματοποιείτε.
Δοκιμάστε το
Ατικatastήstε ό,τι βρίskεtai μέσα σe γώniaδeς μe τis δikές sas timές, kai to placeholder klεidioύ μe éna klεidi apó ton pinaka ελέgchou sas.
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> }'Συνδεθήκατε; Η κονσόλα API στον πίνακα ελέγχου σας συμπληρώνει το πραγματικό αναγνωριστικό του οργανισμού σας και το δικό σας κλειδί, και εκτελεί το αίτημα στο ζωντανό API, ώστε να μπορείτε να δείτε την πραγματική απόκριση. Ανοίξτε αυτό το τελικό σημείο στην κονσόλα API
Λεπτομέρειες
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.
Σώμα αίτησης
| Όνομα | Τύpος | Υποχρεωτικό | Τι είναι |
|---|---|---|---|
name | string | Ναι | What 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. |
zone | string | Ναι | The data centre, as getComputeCatalogue reported it. |
spec | string | Όχι | The 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_code | string | Όχι | The tier to buy, for a catalogue-aware caller. Either this or spec. |
org_id | Uuid | Όχι | The 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.… |
provider | string | Όχι | Which 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… |
image | string | Όχι | The operating system or one-click application the machine boots, as getComputeCatalogue reported it in ComputeProvider.images. ⛔ Required — 422 — on any range that publishes… |
ssh_keys | string[] | Όχι | The ids of the authorised keys to install at build time, from listComputeSshKeys. ⛔⛔… |
blueprint | string<, bare, docker, k3s, k3s_argocd> | Όχι | W43-49 (docs/689). The software stack installed at first boot on a Zinn® Cloud machine: Docker Engine, single-machine k3s, or k3s with Argo CD. Refused on a range whose first… |
term_months | integer | Όχι | How many months to buy up front. Outside 1…36 is refused 422 before a single vendor write, the same bound renewComputeServer applies. |
optimisation | string | Όχι | A stack optimisation profile, as the configurator reported it. |
disk | string | Όχι | An explicit disk allocation, for a provider whose supports_disk_and_bandwidth is true. Sending it to one whose is false is refused. |
bandwidth | string | Όχι | An explicit transfer allocation, for a provider whose supports_disk_and_bandwidth is true. |
Απάντηση
| Όνομα | Τύpος | Υποχρεωτικό | Τι είναι |
|---|---|---|---|
id | Uuid | Ναι | 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 | Ναι | 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 | Ναι | Which compute range the machine belongs to. |
plan_code | string | Ναι | The tier it was bought on, or "" when it was ordered by size alone. |
provider | string | Ναι | Our provider id. |
spec | string | Ναι | The machine size it currently runs. |
zone | string | Ναι | The data centre it runs in. |
status | string<pending, provisioning, active, failed, suspended, terminated, resizing, terminating> | Ναι | 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 | Ναι | Why the order failed, in a sentence the customer reads. Blank unless failed. |
vendor_status | string | Ναι | 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> | Ναι | 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[] | Ναι | 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 | Ναι | The stack optimisation profile it was built with, or "" for none. |
term_months | integer | Ναι | The term it was bought on, or null when the provider states none. |
renews_at | string | Ναι | ⛔ 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 | Ναι | When the row was created, or "" when not stated. |
operable | boolean | Ναι | 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 | Ναι | The provider image the machine was built from. Blank on the resold range, which installs one managed image and offers no choice. |
suspended | boolean | Ναι | ⛔⛔ 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 | Ναι | Why, verbatim, so the customer reads the same sentence support wrote. Blank when the machine is in good standing. |
capabilities | string[] | Ναι | ⭐⭐ What this machine's provider can actually do — capability tokens such as compute:snapshots, compute:console, compute:firewall, compute:backups_manage and… |
billing | ComputeServerBilling | Ναι | 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 | Ναι | 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> | Ναι | The software stack installed at first boot. Blank for none. |
cluster_id | string | Ναι | The cluster this machine is a node of, or blank. |
cluster_role | string<, server, agent> | Ναι | — |
Σφάλματα που μπορεί να επιστρέψει αυτό το τελικό σημείο
401 · 403 · 404 · 422 · 429 · 503