Skip to main content
POST https://api.acedata.cloud/webextrator/tasks WebExtrator タスククエリ API は、過去の render / extract タスク結果を照会するために使用されます。一般的な使用法:
  • 非同期タスク完了後に再照会して完全なエンベロープを取得(callback_url プッシュまたは手動ポーリングを除く)。
  • 監査自分が提出した内容を確認する —— タスク記録は元の request と最終 response を同時に保存します。
  • バッチ回填 —— 一度に id または trace_id で複数のレコードを取得。
タスク記録は Redis に 7 日間保持されます。 タスククエリインターフェースは無料(クレジット使用量にはカウントされません)。

認証

自分の AceDataCloud アカウント下のタスクのみを照会できます。

リクエストパラメータ

リクエストボディは action によって区別される判別式の組み合わせで、2 つのアクションがあります:

action: "retrieve" —— 単一照会

idtrace_id は二者択一で渡します。

action: "retrieve_batch" —— バッチ照会

idstrace_ids は二者択一で渡します。

単一レスポンス

見つからない場合は { "task": null } を返します(HTTP 200、404 ではありません)。 task オブジェクトのタイミングフィールドの説明は以下の通りです。
  • created_at、タスク作成時間、Unix タイムスタンプ(秒、浮動小数点)。
  • started_at、タスク開始実行時間、Unix タイムスタンプ(秒、浮動小数点)。タスクがまだ開始されていない場合は null
  • finished_at、タスク完了時間、Unix タイムスタンプ(秒、浮動小数点)。タスクが未完了の場合は null
  • elapsed、タスク実行にかかった時間、単位は秒(浮動小数点、3 桁の小数点以下を保持)。タスクが未完了の場合は null

バッチレスポンス

存在しない ID はエラーにならず、単に tasks から欠落します。

task_id による単一照会

trace_id による単一照会

バッチ照会

Python (requests) —— 完了するまでポーリング

Node.js (fetch) —— コールバックを受け取った後に完全なエンベロープを取得

エラーレスポンス

ヒントと落とし穴

  • trace_id をカスタマイズ可能であればカスタマイズしてください。 原始の render/extract リクエストで ?trace_id=…(クエリストリング)をアップロードし、それを自分のビジネス ID(ワークフローの run id など)に合わせてください。そうすれば、ビジネス ID でタスクを検索できます。送信しなかった場合、サーバーは自動的に UUID を生成します。
  • 保持期間は 7 日です。 それ以前のタスクは task: null を返します —— 長期的なアーカイブが必要な場合は、自分でデータベースに保存してください。
  • タスクのクエリは無料です。 何回でも調べたいだけ調べてください。原始の render/extract 呼び出し時に費用はすでに支払われています。
  • 非同期 + コールバックを優先し、ポーリングではなく。 ビジネスが許可する場合、元のリクエストに callback_url を渡し、プラットフォームがエンベロープをあなたにプッシュするようにしてください。2 秒ごとにポーリングするよりも効率的です。