ToAPIsToAPIs
ユーザーファイル

ファイル削除進捗の取得

自身の削除リクエストの状態と累計進捗を取得

GET
/api/v1/user/file/deletion-requests/{id}

中国本土のユーザー向け: 中国本土のユーザーは https://api.toapis.cn を API エンドポイント (Base URL)としてご利用ください. 本ドキュメント内の例では https://api.toapis.com を https://api.toapis.cn に置き換えてください.

動作

自身の削除リクエストを取得します. 他人のリクエストと存在しないリクエストは共に 404 です. 件数は非同期更新され, 一覧からファイルが消えた後も削除済み累計を保持します. processed は現在発見済みの範囲の完了を示し, 古いファイルの遅延登録で範囲や状態が再び変わる場合があります. 未登録オブジェクトの削除を証明するものではありません.

認証

Authorizationstringヘッダー必須

システムアクセストークンを Bearer YOUR_SYSTEM_ACCESS_TOKEN で送信します. モデル API キーは利用できず, X-User-Id は不要です. 認証アカウント自身のファイルと設定のみが対象で, サブアカウントは集約しません.

リクエストパラメータ

idstringパス必須

削除作成時に返された十進文字列 id, 例 "456". ファイル ID ではなく削除リクエスト ID です.

クエリパラメータと本文はありません. 未知または重複したクエリパラメータは 400 です.

リクエスト例

curl --request GET \
  --url 'https://api.toapis.com/api/v1/user/file/deletion-requests/456' \
  --header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN'
import requests

response = requests.get(
    "https://api.toapis.com/api/v1/user/file/deletion-requests/456",
    headers={"Authorization": "Bearer YOUR_SYSTEM_ACCESS_TOKEN"},
    timeout=30,
)
response.raise_for_status()
print(response.json())
const response = await fetch("https://api.toapis.com/api/v1/user/file/deletion-requests/456", {
  method: "GET",
  headers: { Authorization: "Bearer YOUR_SYSTEM_ACCESS_TOKEN" },
  signal: AbortSignal.timeout(30_000),
});
if (!response.ok) {
  throw new Error(`HTTP ${response.status}: ${await response.text()}`);
}
console.log(await response.json());

レスポンスフィールド

例は架空のデータです. 共通のレスポンス形式は利用方法を参照してください.

data.idstring

進捗照会用の削除リクエスト ID.

data.scopestring

single は指定 1 ファイルの削除, all は現在のアカウントの既存ファイルの全削除です.

data.file_idstring | null

単一削除ではファイル ID, 一括では null.

data.created_before_atstring | null

一括削除の作成日時の上限. その時刻を含み, 単一削除は null.

data.statestring

pending: 受理; running: 実行中; processed: 現在範囲の完了; blocked: 対象ファイルの停止または進捗更新の失敗.

data.discovered_countinteger

現在発見済みの対象数. 遅延登録で増える場合があります.

data.deleted_countinteger

削除済みの累計. 一覧からファイルが消えた後も保持します.

data.blocked_countinteger

停止中のファイル数. 進捗更新自体が失敗した場合も blocked となり, 件数は前回成功値を保持します.

data.created_atstring

リクエスト作成日時.

data.updated_atstring

進捗の最終更新日時.

レスポンス例

{
  "code": 0,
  "message": "",
  "data": {
    "id": "456",
    "scope": "single",
    "file_id": "123",
    "created_before_at": null,
    "state": "processed",
    "discovered_count": 1,
    "deleted_count": 1,
    "blocked_count": 0,
    "created_at": "2026-11-16T08:00:00Z",
    "updated_at": "2026-11-16T08:02:00Z"
  }
}

エラー

不正なリクエスト ID やクエリパラメータは 400 です. 削除リクエストが存在しないか他人の所有なら 404, 進捗の読み取りが一時的に利用できない場合は 503 です.

共通の認証, レート制限, エラー処理は利用方法を参照してください.