身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 hosting.import.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X POST https://api.zinndigital.com/v1/site-imports/{importId}/cancel \
-H "Authorization: Bearer zdk_live_…"已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
Marks the job cancelled. The running workflow notices at the top of its next fetch batch and stops cleanly, which leaves the job's rows consistent — cancelling the workflow itself would abort mid-batch with items half-written. An already-finished job returns 422. Requires `hosting.import.manage`.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
importId (path) | Uuid | 是 | Site-import job ID (UUIDv7). |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
id | Uuid | 是 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | string | 否 | The site this import lands on, or empty. Empty is a real outcome, not an error: an aged-domain restore produces a downloadable bundle and the customer picks the target afterwards. |
source | SiteImportSource | 是 | Where the content comes from. ⛔ Deliberately not the same enum as a site's `source`: that one records what a site was built from, for ever, while this selects a fetch strategy a… |
output | SiteImportOutput | 是 | What the import produces. Both are supported; neither is a default. |
status | SiteImportStatus | 是 | `fetching` and `building` are separate states rather than one `running` because they fail for opposite reasons and the customer's next action differs — a stall in `fetching` is… |
status_reason | string | 否 | A machine code the dashboard renders through its own catalogue — never an English sentence composed by the engine, which could not be shown to the other 57 locales. |
source_domain | string | 是 | — |
target_domain | string | 否 | — |
snapshot_day | string | 否 | — |
crawl_depth | integer | 否 | — |
urls_total | integer | 是 | — |
urls_done | integer | 是 | — |
urls_failed | integer | 是 | — |
progress_percent | integer | 是 | For a progress bar only. The per-URL counters are the primary display, because a percentage cannot say *which* step. |
requests_spent | integer | 是 | — |
request_budget | integer | 是 | — |
budget_exhausted | boolean | 是 | True when the job stopped because it ran out of requests. Surfaced deliberately — it otherwise looks identical to a job that finished, and the customer's next action depends on… |
bundle_bytes | integer | 否 | — |
created_at | string | 是 | — |
started_at | string | 否 | — |
finished_at | string | 否 | — |
can_cancel | boolean | 是 | — |
此端点可能返回的错误
401 · 403 · 404 · 422 · 429