hosting
GET /v1/sites/{siteId}/migrations/{migrationId}
One migration's state and progress.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.view 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
此端点不需要组织 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 reachable… |
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: a… |
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… |
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 faithfully… |
replaces_existing | boolean | 否 | Whether this migration landed on a site that already held a website. Stamped when the job is created and never recomputed: after the apply step the site is occupied… |
safety_backup_state | string<not_needed, pending, taken, unsupported, failed> | 否 | What became of the backup taken immediately before the apply step replaced the site. ⛔ Five values rather than a boolean: "there is no safety backup" is one rendered sentence… |
safety_backup_id | string | 否 | The SiteBackup id, or "". ⛔ Still reported after the archive has been pruned by retention, so a rollback can say "that archive has expired" rather than looking like a… |
rolled_back_at | string | 否 | When the customer put the site back. Set once — restoring the pre-migration archive over a site that is already the pre-migration archive can only lose work done since. |
rollback | MigrationRollback | 否 | Whether this migration can be put back, and — when it cannot — why not. ⛔⛔ reason travels with available, always. Six different facts render as the same absent button… |
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