身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.view 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X POST https://api.zinndigital.com/v1/compute/servers/{serverId}/renew \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "term_months": <integer> }'已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
Buys more months on an existing machine and returns the server with `term_months` grown by what was asked. ⛔ **This charges immediately**, and — unlike a resize — there is deliberately **no quote operation to read first**. That asymmetry is real rather than an omission: a resize is priced by the provider, whereas a renewal is priced by the plan the customer is already on, and no figure on this surface carries it (a machine size has no price by design, and a server carries only a `plan_code`). A client says out loud that it cannot show a figure rather than inventing one (§2.8). The engine attaches an idempotency key derived from the server and the term, so a retry cannot buy the extension twice. `404` for a server that is not the caller's; `422` for a term outside 1…36 months, or a machine that is not `active`. 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. |
请求正文
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
term_months | integer | 是 | Months to add to the existing term. Outside 1…36 is refused `422` before the provider is called. |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
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