版本 2.4.8 · 最新
刷新与预热 cache-jobs
刷新(清除)缓存的 URL 或目录,以及预热指定 URL。
点击任一接口,右侧显示对应的调用示例。
缓存鉴权: 用户(部分参数仅管理员)3 个接口
鉴权
请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。
X-API-Key
鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。
约定
分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。
时间一律 RFC 3339(UTC);金额单位为分。
写操作成功回 200/201/204;重复提交按资源唯一键回 409。
GET
/api/v2/cache-jobs列出刷新/预热任务
鉴权: 用户(部分参数仅管理员)
查询参数
| 字段 | 类型 | 说明 |
|---|---|---|
page | integer | 页码,从 1 开始。 |
page_size | integer | 每页条数。 |
sort | string | 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。 |
tenant_id | integer | 仅管理员可用:按租户过滤(格式错 422)。租户凭据调用时忽略,只返回本租户数据。 |
type | string | 只列该类型的任务。 |
url | string | 以 http:// 或 https:// 开头时按完整 URL(同提交时规范化)精确匹配(任务的 URL 列表里含它);否则按主机名精确匹配。 |
POST
/api/v2/cache-jobs创建刷新/预热任务
鉴权: 用户(部分参数仅管理员)
请求体 application/json
| 字段 | 类型 | 说明 |
|---|---|---|
type必填 | string | purge_url 刷新 URL;purge_dir 刷新目录(URL 以 / 结尾);prefetch 预热。 |
urls必填 | string[] | http(s)://主机/路径(规范化后,见创建接口);预热一次最多 100 条。 |
GET
/api/v2/cache-jobs/{id}获取刷新/预热任务
鉴权: 用户(部分参数仅管理员)
刷新与预热对象
| 字段 | 类型 | 说明 |
|---|---|---|
batches | integer | 这次提交被拆成几个下发任务(预热按节点超时拆批,刷新恒为 1)。id、urls、status、progress、regions、results 都是整个提交各批合并后的值。 |
by_admin | boolean | 是否管理员代发(true 时不占租户的每日额度);租户自己提交为 false。 |
created_at | string | 创建时间 |
id | integer | 记录 ID |
progress | CacheJobProgress | 任务在全部节点上的进度(只读,只给计数)。下发节点数 total = 已回结果的节点 + 在用节点里还没回结果的(任务还在进行时);任务结束后只算回过结果的节点。 |
regions | CacheJobRegion[] | 按区域汇总的节点进度(只在详情里回),按 total 降序;没有区域的节点归入「未分区」。租户与管理员结构相同,只给计数,不含节点名、IP、节点 ID。 |
results | CacheJobNodeResult[] | 各节点的执行结果(只在详情里回;只有管理员看得到节点,租户这里恒为空数组,进度看 progress、regions)。 |
site_id | integer | 网站 ID |
status | string | 下发任务的状态(有节点失败时 pending 退避重试,次数用完 failed)。多批时任一批 failed 即 failed,其余有没结束的为 running/pending,全部完成才是 done。 |
tenant_id | integer | 所属租户(用户)ID |
tenant_name | string | 任务所属租户的显示名;租户自己调用时也回自己的名字;租户已删除时省略。 |
type | string | purge_url 刷新 URL;purge_dir 刷新目录(URL 以 / 结尾);prefetch 预热。 |
updated_at | string | 更新时间 |
urls | string[] | http(s)://主机/路径(规范化后,见创建接口);预热一次最多 100 条。 |
返回与错误
成功直接回资源 JSON(HTTP 2xx);失败回 application/problem+json(code、detail,校验失败带 errors);列表为 items + total。
成功
{
"id": 1,
"name": "example"
}列表
{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}失败
{
"code": "validation_failed",
"detail": "请求参数不合法",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name 必填"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}