compute
POST /v1/compute/servers/{serverId}/snapshots
Take a snapshot of a server now.
認証
ベアラー トークンとして API キーを送信します。キーには billing.payment.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織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 measuri… |
price_currency | string | はい | ISO-4217 code for `price_minor`, or `""` exactly when that is `null`. |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429 · 503