compute

POST /v1/compute/servers/metered

Order a server paid for by the hour from the account balance.

همه نقاط پایانی compute

همهٔ مستندات توسعه‌دهندگان

احراز هویت

یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمی‌کند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.

جایی که شناسه سازمان شما قرار می‌گیرد

این نقطه پایانی org_id را به عنوان یک فیلد در بدنه JSON دریافت می‌کند.

شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواست‌هایی که ارسال می‌کنید یکسان است.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

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

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید

جزئیات

W43-47, docs/687. Charges nothing now. The same refusals as any order apply (verification, SSH keys, zones, sizes), and three more: the account must be active, the range must be one we hold the provider account for, and the balance must cover min_funded_hours (24) at the machine's rate. A first pay-by-the-hour order grants the one-time Cloud trial credit — $10, converted into the account's own currency — before that check. Every started hour is then rated at the pinned rate, never exceeding the monthly price in a calendar month, and drawn from the balance with tax as a compute_usage order. A card on file is never charged for these hours. term_months is ignored: a metered machine has no term.

بدنه درخواست

نامنوعالزامیچیست
namestringبله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.
zonestringبلهThe data centre, as getComputeCatalogue reported it.
specstringخیر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_codestringخیرThe tier to buy, for a catalogue-aware caller. Either this or spec.
org_idUuidخیر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.…
providerstringخیر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…
imagestringخیر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_keysstring[]خیرThe ids of the authorised keys to install at build time, from listComputeSshKeys. ⛔⛔…
blueprintstring<, 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_monthsintegerخیرHow many months to buy up front. Outside 1…36 is refused 422 before a single vendor write, the same bound renewComputeServer applies.
optimisationstringخیرA stack optimisation profile, as the configurator reported it.
diskstringخیرAn explicit disk allocation, for a provider whose supports_disk_and_bandwidth is true. Sending it to one whose is false is refused.
bandwidthstringخیرAn explicit transfer allocation, for a provider whose supports_disk_and_bandwidth is true.

پاسخ

نامنوعالزامیچیست
idUuidبله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.
namestringبله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_targetstringبلهWhich compute range the machine belongs to.
plan_codestringبلهThe tier it was bought on, or "" when it was ordered by size alone.
providerstringبلهOur provider id.
specstringبلهThe machine size it currently runs.
zonestringبلهThe data centre it runs in.
statusstring<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…
messagestringبلهWhy the order failed, in a sentence the customer reads. Blank unless failed.
vendor_statusstringبلهThe 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>بله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…
addressesstring[]بلهPublic addresses if the provider states them. Empty means not stated, never "none" — a machine rendered as having no address reads as broken.
optimisationstringبلهThe stack optimisation profile it was built with, or "" for none.
term_monthsintegerبلهThe term it was bought on, or null when the provider states none.
renews_atstringبله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_atstringبلهWhen the row was created, or "" when not stated.
operablebooleanبله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…
imagestringبلهThe provider image the machine was built from. Blank on the resold range, which installs one managed image and offers no choice.
suspendedbooleanبله⛔⛔ 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_reasonstringبلهWhy, verbatim, so the customer reads the same sentence support wrote. Blank when the machine is in good standing.
capabilitiesstring[]بله⭐⭐ What this machine's provider can actually do — capability tokens such as compute:snapshots, compute:console, compute:firewall, compute:backups_manage and…
billingComputeServerBillingبله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_userstringبله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…
blueprintstring<, docker, k3s, k3s_argocd>بلهThe software stack installed at first boot. Blank for none.
cluster_idstringبلهThe cluster this machine is a node of, or blank.
cluster_rolestring<, server, agent>بله

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401 · 403 · 422 · 429 · 503