compute

POST `/v1/compute/servers/{serverId}/snapshots`

Take a snapshot of a server now.

所有 compute 端点

所有开发者文档 →

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 billing.payment.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

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

已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。在 API 控制台中打开此端点

详细信息

Images the machine's disk as it is right now, so the customer has a point to come back to before an upgrade or a risky change. ⛔ It bills for storage until it is deleted. It is not destructive — snapshotting a running machine changes nothing about it — but it is a recurring cost, so it is gated on the spend key rather than on the operate key. The snapshot comes back with ready: false: imaging a disk takes minutes and the request is not held for it. Poll the listing; a restore must not be offered until ready is true. Requires billing.payment.manage.

参数

名称	类型	必填	内容简介
`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.

请求正文

名称	类型	必填	内容简介
`description`	`string`	是	What to call it. Required and non-blank: an unnamed snapshot renders as a bare provider id, and a list of bare ids is one a customer cannot choose a restore point from.

响应

名称	类型	必填	内容简介
`id`	`string`	是	The provider's identifier for the image.
`description`	`string`	是	What the customer called it, or `""`.
`created_at`	`string`	是	When it was taken, ISO-8601 as the provider states it, or `""`.
`size_gb`	`number`	是	Billable size. `null` while the provider is still measuring it — which it is for the first seconds after creation. ⛔ "Not measured yet" and "takes no space" are different claims…
`ready`	`boolean`	是	`false` while the provider is still writing it. ⛔ A restore offered on an unfinished snapshot restores an incomplete disk, and the provider will start it.
`price_minor`	`integer`	是	What we charge per month to keep this snapshot, in integer minor units of `price_currency`. ⛔ `null` exactly while `size_gb` is `null`: the provider has not finished measuring…
`price_currency`	`string`	是	ISO-4217 code for `price_minor`, or `""` exactly when that is `null`.

此端点可能返回的错误

401 · 403 · 404 · 422 · 429 · 503

POST /v1/compute/servers/{serverId}/snapshots