跳转到主要内容
GET
获取迁移状态

限制说明

使用说明

  • 轮询直到 status 不再是 running;progress.completed_steps 与 progress.total_steps 之比表示任务进度。
  • 任务状态在最后一次更新后保留 24 小时,过期后调用返回 ResourceNotFound。
  • job_id 属于其他账户时返回 AccessDenied。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

查询参数

job_id
string
必填

由 migrate-structure 或 migrate-email-subscribers 返回的迁移任务 ID。

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse。

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

迁移任务的当前状态及进度。