compute
POST /v1/compute/servers/metered
Order a server paid for by the hour from the account balance.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
組織 ID を入力する場所
このエンドポイントは、JSONボディのフィールドとして org_id を受け取ります。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
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コンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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.
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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 · 422 · 429 · 503