hosting
POST /v1/sites/{siteId}/migrations/{migrationId}/cancel
Stop a running migration.
Баталгаажуулалт
API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Түлхүүр нь hosting.import.manage эрхтэй байх ёстой бөгөөд үүнгүйгээр 404 биш, харин 403 алдаа буцааж татгалзах болно.
Энэ төгсгөл цэг нь ямар ч байгууллагын ID шаардахгүй. Таны түлхүүр аль хэдийн харьяалагдах байгууллагыг тодорхойлж байгаа бөгөөд хариу нь тухайн байгууллагын хүрээнд хязгаарлагдана.
Туршиж үзэх
Өнцөг хаалтанд байгаа бүх зүйлийг өөрийн утгаар солиж, түлхүүр санамж байрлуулагчийг хяналтын самбарынхаа түлхүүрээр сольж оруулна уу.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/migrations/{migrationId}/cancel \
-H "Authorization: Bearer zdk_live_…"Та нэвтэрсэн байна уу? Таны хяналтын самбар дахь API консол нь таны бодит байгууллагын ID болон өөрийн түлхүүрийг автоматаар бөглөж, шууд ажиллаж буй API рүү хүсэлт илгээх тул та бодит хариуг харах боломжтой болно. Энэ төгсгөлийн цэгийг API консол дээр нээх
Дэлгэрэнгүй
Marks the job cancelled. The running workflow notices at the top of its next round and stops cleanly, which leaves the item rows consistent and closes the session on the source host — cancelling the workflow itself would abort mid-item, with a half-written file on the new site and an open connection to somebody else's production server. An already-finished job returns 422 with migration_not_cancellable. Requires hosting.import.manage.
Параметрүүд
| Нэр | Төрөл | Заавал шаардлагатай | Энэ юу вэ |
|---|---|---|---|
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 | Тийм | — |
Энэ төгсгөл цэгээс буцааж болох алдаанууд
401 · 403 · 404 · 422 · 429