hosting
GET /v1/sites/{siteId}/migrations/{migrationId}
One migration's state and progress.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/migrations/{migrationId} \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
A pure database read, polled by the progress screen. Progress is per-kind counters rather than only a percentage, because "which step" is the useful answer when a customer asks why a migration is slow, and `items_failed` is reported separately from the `*_done` counts so a job that could not fetch part of the estate cannot report itself complete. Requires `sites.view`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
migrationId (path) | Uuid | はい | The migration job's id (UUIDv7), as `listSiteMigrations` reports it. **Ours**, minted when the row was written — never anything the source host knows about. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
source | MigrationSource | はい | The kind of hosting the site is being pulled from. ⛔ `plesk` is offered so the refusal can be specific and actionable, **not** because it is supported: `pleskbackup` is reachabl… |
status | SiteMigrationStatus | はい | `authenticating`, `inventorying` and `transferring` are separate states rather than one `running` because they fail for opposite reasons and the customer's next action differs:… |
status_reason | string | いいえ | A machine code the dashboard renders through its own catalogue — never an English sentence composed by the engine, which could be shown to none of the other 57 locales. |
include_mail | boolean | はい | — |
source_host | string | いいえ | The hostname the estate is being pulled from. Host only: no port, no username, and never a secret. |
files_total | integer | はい | — |
files_done | integer | はい | — |
databases_total | integer | はい | — |
databases_done | integer | はい | — |
mailboxes_total | integer | はい | — |
mailboxes_done | integer | はい | — |
items_failed | integer | はい | ⛔ Counted separately from the `*_done` fields, never folded into them. "We could not get it" reported as "done" makes the completion report a lie. |
bytes_transferred | integer | はい | — |
warnings | string[] | はい | Machine warning codes the dashboard localises. |
mail_synced_at | string | いいえ | When the mail delta last ran. `null` and a timestamp are different states, and the cutover control reads this to tell them apart. |
dns_records_captured | integer | いいえ | How many records were read off the source's zone and will be published on cutover. ⛔ Counted separately from `dns_records_unsupported`, never as one total: "we captured 14 recor… |
dns_records_unsupported | integer | いいえ | Real records the source holds that our DNS editor cannot express (an `SSHFP`, a `TLSA`, an `MX` with no preference). Stored and listed on the detail endpoint rather than dropped… |
dns_captured_at | string | いいえ | When the source's zone was read. `null` means never attempted, which is NOT the same as attempted-and-the-panel-holds-no-zone; only the first is worth retrying. |
verified_at | string | いいえ | When the migrated site was last fetched over HTTP and compared with the source. `null` means the destination has never been looked at. |
verification_code | string | いいえ | A machine code the dashboard localises. Empty means the destination is serving the site as well as the source was. ⛔ The migration's own counters cannot answer this: they travel… |
destination_status | integer | いいえ | The HTTP status the migrated site returned, fetched at its origin address with a `Host:` header — before cutover the customer's domain still resolves to the OLD host, so asking… |
source_status | integer | いいえ | The HTTP status the source returned. ⭐ Reported beside `destination_status` because the interesting failure is the PAIR: a destination 200 against a source 500 means we faithful… |
started_at | string | いいえ | — |
finished_at | string | いいえ | — |
created_at | string | はい | — |
dns_records | MigrationDnsRecord[] | はい | — |
dns_plan | MigrationDnsPlan | はい | The **dry run**: exactly what the cutover will do to the zone, before it does it. Computed by the same function the cutover publishes from, so it cannot drift from what actually… |
report | MigrationReport | はい | What the customer is told about the migration, in their own language. `null` until the report step has run — which is a real state while files are still copying, and is **not**… |
このエンドポイントが返すエラー
401 · 403 · 404 · 429