设置文件保留期
设置或取消当前账号的文件保留期限
国内用户请注意: 中国大陆用户请使用 https://api.toapis.cn 作为接口地址 (Base URL). 文档示例中的 https://api.toapis.com 请替换为 https://api.toapis.cn.
使用说明
设置当前账号的文件保留天数. 例如 7 表示从文件创建起保留 7 天; 传 null 取消自定义设置, 按平台保留规则处理.
平台默认保留 30 天, 实际上限以平台当前配置为准. 自定义天数不能超过该上限: 上限为 30 天时, 30 可以保存, 31 返回 400. 用户保留期在平台自动清理开启时生效, 对已有及之后创建的普通文件均适用.
清理异步执行. 缩短期限可能使已有文件在下一次清理时被删除. 延长或取消保留期不会撤销已经开始的删除流程, 也不影响已提交的手动删除请求.
不接受查询参数. 请求体必须是 JSON 对象, 最多 4096 字节, 拒绝未知字段和重复字段, 正文读取期限为 10 秒. 写操作与其他公开账户写接口共享每用户每分钟 10 次的额度. 服务暂时不可用时返回 503.
鉴权
Authorizationstring请求头必填使用系统访问令牌, 格式为 Bearer YOUR_SYSTEM_ACCESS_TOKEN. 不接受模型 API Key, 无需 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).
通用鉴权, 限流和错误处理见接入方式.