ToAPIsToAPIs
ユーザーファイル

ファイル保持期間の設定

現在のアカウントのファイル保持期間を設定または解除

PUT
/api/v1/user/file/retention

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

動作

現在のアカウントのファイル保持日数を設定します. 7 は作成から 7 日間を示します. null で独自設定を解除し, プラットフォームの規則に従います.

既定の保持期間は 30 日で, 実際の上限はプラットフォームの現在の設定によります. 独自設定はこの上限を超えられません. 上限が 30 日の場合, 30 は保存でき, 31 は 400 を返します. 自動削除が有効な間, 既存および新規作成の通常ファイルに適用されます.

削除は非同期です. 短縮により既存ファイルが次回の削除対象になる場合があります. 延長や解除で進行中の削除や提出済みの手動削除リクエストは取り消されません.

クエリパラメータは不可です. 本文は最大 4096 バイトの JSON オブジェクトで, 未知または重複フィールドを拒否します. 本文読み取り期限は 10 秒です. 公開アカウントの書き込み上限はユーザーごと毎分 10 回を共有します. サービスが一時的に利用できない場合は 503 です.

認証

Authorizationstringヘッダー必須

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

リクエストパラメータ

retention_daysintegerボディ必須

必須の JSON 正整数または null. 正整数は現在のプラットフォーム上限以下にしてください. 既定の上限は 30 日です. 7 は 7 日間, null は独自設定を解除しプラットフォームの規則に従います. 省略, 0, 負数, 小数, 数字文字列は無効です.

リクエスト例

curl --request PUT \
  --url 'https://api.toapis.com/api/v1/user/file/retention' \
  --header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"retention_days":7}'
import requests

response = requests.put(
    "https://api.toapis.com/api/v1/user/file/retention",
    headers={"Authorization": "Bearer YOUR_SYSTEM_ACCESS_TOKEN"},
    json={"retention_days": 7},
    timeout=30,
)
response.raise_for_status()
print(response.json())
const response = await fetch("https://api.toapis.com/api/v1/user/file/retention", {
  method: "PUT",
  headers: { Authorization: "Bearer YOUR_SYSTEM_ACCESS_TOKEN", "Content-Type": "application/json" },
  body: JSON.stringify({"retention_days": 7}),
  signal: AbortSignal.timeout(30_000),
});
if (!response.ok) {
  throw new Error(`HTTP ${response.status}: ${await response.text()}`);
}
console.log(await response.json());

ユーザー保持期限の解除:

curl --request PUT \
  --url 'https://api.toapis.com/api/v1/user/file/retention' \
  --header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"retention_days":null}'

レスポンスフィールド

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

data.retention_daysinteger | null

ユーザー設定の保持日数. null は独自設定なしで, プラットフォームの規則に従います. 既定は 30 日です.

レスポンス例

{
  "code": 0,
  "message": "",
  "data": {
    "retention_days": 7
  }
}

エラー

現在の上限を超える場合は 400 (code=17052) を返し, 設定は保存しません. エラーメッセージは Accept-Language に応じて許容範囲を示します. data.params.max は現在の最大日数です.

retention_days の欠落や不正, 不正な JSON, クエリパラメータは 400 です. 書き込みまたは書き込み枠が利用できない場合は 503 (code=13035) です.

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