跳至文檔內容
開發者文檔API 參考查詢操作進度
GETBearer 權杖

查詢操作進度

/api/v1/tasks/:taskKey

查詢所屬操作的持久化狀態。state 與供應商 taskStatus 意義不同。回應不會包含登入憑證或錢包簽章。

API 欄位名稱、型別與程式碼在所有語言中保持原樣。

請求範例

cURL
curl "https://tovahub.com/api/v1/tasks/server%3A507f1f77bcf86cd799439012%3Arestart%3Adocs_example_001" \
  -H "Authorization: Bearer $TOVAHUB_TOKEN"

僅提供範例,此頁不會發送 API 請求。

參數

taskKey路徑 · 必填

string

8–240 個字元,僅限英文字母、數字、冒號、底線或連字號。請原樣使用回傳的 taskKey。

回應

HTTP 狀態 200

讀取組織現有操作的持久化狀態。

taskKeystring

固定的平台操作鍵值。

actionstring

記錄的操作名稱。

statestring ('started' | 'succeeded' | 'failed')

平台端的操作狀態,與供應商工作狀態不同。

pendingboolean

平台端或供應商端是否完成仍未確認時,為 true。

localFinishPendingboolean

快照請求為 succeeded、有已儲存的回應與有效完成時間、無供應商任務 ID,且本機受理收尾尚未完成時為 true。請以原 action 與 requestKey 呼叫 recover_snapshot;任務 GET 維持唯讀。

taskIdstring | null

供應商工作識別碼(若有)。

taskStatusstring | null

最後觀測到的供應商工作狀態。

errorstring | null

經過敏感資訊清理的錯誤記錄(若有)。

createdAtstring (ISO 8601)

平台端操作建立時間。

finishedAtstring (ISO 8601) | null

平台端完成時間(若有)。

actorUserIdstring (ObjectId) | null

原操作人帳號編號;歷史缺失為null。目前讀者須為同一固定團隊的有效成員。