compute
POST /v1/compute/servers/{serverId}/resize
Move a server onto another machine size.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/compute/servers/{serverId}/resize \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "spec": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Performs the upgrade and returns the server's new state. ⛔ **This charges immediately at every provider we support**, so it is only ever reached from a quote the customer has read (`quoteComputeServerResize`). The engine attaches an idempotency key derived from the server and the target size, so a retry cannot buy the resize twice. ⛔⛔ **A size whose disk is smaller than what the machine is already using is refused with a `422`, and that is a data-loss gate rather than a tidiness check.** The provider's endpoint is an *upgrade* endpoint and usually refuses a shrink, but "usually" is not a promise to make about a customer's files. Before a shrink the engine reads the machine's live disk usage and requires the target to be strictly larger. It **fails closed**: if the provider does not answer, or answers `-1` ("did not say"), the resize is refused rather than attempted — `-1 < anything` would otherwise read as "plenty of room". Growing is never gated, never pays for the extra read, and never fails because usage statistics were unavailable. RAM is not gated: running with less memory loses nothing on disk and is the customer's call. `404` for a server that is not the caller's; `422` for a size the provider does not offer, a machine that is not `active` — an order still running would have two writers, and a failed or released one has nothing to write to — or a shrink below the disk in use. Requires `sites.view` **and** `billing.payment.manage` — ⛔ **not** `sites.create`, which is what this was until #1682.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
serverId (path) | Uuid | はい | The server's id, as `listComputeServers` reports it. **Ours** (UUIDv7), minted when the order row was written — never the provider's own identifier for the machine. |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
spec | string | はい | The target size, as `getComputeCatalogue` reported it. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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> | はい | 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 t… |
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'… |
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 an… |
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 `compute… |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429 · 503