ದೃಢೀಕರಣ
ಬೇರರ್ ಟೋಕನ್ ಆಗಿ API ಕೀಯನ್ನು ಕಳುಹಿಸಿ. ಕೀಯು sites.view ಅನುಮತಿಯನ್ನು ಹೊಂದಿರಬೇಕು; ಅದನ್ನು ಹೊಂದಿರದ ಕೀಯನ್ನು 404 ಬದಲಿಗೆ 403 ನೊಂದಿಗೆ ತಿರಸ್ಕರಿಸಲಾಗುತ್ತದೆ.
ನಿಮ್ಮ ಸಂಸ್ಥೆಯ ಐಡಿ ಬರುವ ಸ್ಥಳ
ಈ ಎಂಡ್ಪಾಯಿಂಟ್ JSON ಬಾಡಿಯಲ್ಲಿ ಒಂದು ಕ್ಷೇತ್ರವಾಗಿ org_id ಅನ್ನು ತೆಗೆದುಕೊಳ್ಳುತ್ತದೆ.
ನಿಮ್ಮ ಸಂಸ್ಥೆಯ ಐಡಿಯು ನಿಮ್ಮ ಡ್ಯಾಶ್ಬೋರ್ಡ್ನಲ್ಲಿರುವ API ಕೀಗಳ ಪರದೆಯ ಮೇಲೆ, ಕೀ ಯ ಪಕ್ಕದಲ್ಲೇ ಇರುತ್ತದೆ. ನೀವು ಮಾಡುವ ಪ್ರತಿಯೊಂದು ಕರೆ(call)ಯಲ್ಲೂ ಇದು ಒಂದೇ ಐಡಿ ಆಗಿರುತ್ತದೆ.
ಪ್ರಯತ್ನಿಸಿ
ಕೋನೀಯ ಬ್ರಾಕೆಟ್ಗಳಲ್ಲಿರುವ ಯಾವುದೇ ಅಂಶವನ್ನು ನಿಮ್ಮ ಸ್ವಂತ ಮೌಲ್ಯಗಳೊಂದಿಗೆ ಮತ್ತು ಕೀ ಪ್ಲೇಸ್ಹೋಲ್ಡರ್ ಅನ್ನು ನಿಮ್ಮ ಡ್ಯಾಶ್ಬೋರ್ಡ್ನಲ್ಲಿರುವ ಕೀಯೊಂದಿಗೆ ಬದಲಾಯಿಸಿ.
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 ಕನ್ಸೋಲ್ ನಿಮ್ಮ ನೈಜ ಸಂಸ್ಥೆಯ ID ಮತ್ತು ನಿಮ್ಮ ಸ್ವಂತ ಕೀಲಿಯನ್ನು ಭರ್ತಿ ಮಾಡುತ್ತದೆ, ಮತ್ತು ಲೈವ್ 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.
ಅನ್ವಯದ ದೇಹ
| ಹೆಸರು | ಪ್ರಕಾರ | ಅಗತ್ಯವಿದೆ | ಏನಿದು |
|---|---|---|---|
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. |
ಪ್ರತಿಕ್ರಿಯೆ
| ಹೆಸರು | ಪ್ರಕಾರ | ಅಗತ್ಯವಿದೆ | ಏನಿದು |
|---|---|---|---|
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