版本 2.4.8 · 最新
站点缓存分组与本站改动 cache-sites
查看或设置单个站点使用的缓存分组与本站改动(新增 / 修改 / 删除规则、忽略参数清单)。
点击任一接口,右侧显示对应的调用示例。
缓存鉴权: 用户(部分参数仅管理员)5 个接口
鉴权
请求头带 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-sites/{id}站点的缓存分组与本站改动
鉴权: 用户(部分参数仅管理员)
PUT
/api/v2/cache-sites/{id}站点换缓存分组
鉴权: 用户(部分参数仅管理员)
请求体 application/json
| 字段 | 类型 | 说明 |
|---|---|---|
expected_updated_at | string | 乐观锁(修改时用):调用方读到的站点 updated_at。与库里当前值不等则回 409 stale_version、不保存;不带则不检查;创建时忽略。 |
group_id必填 | integer | 显式引用的分组;null = 按默认分组。 |
keep | boolean | 换分组时是否保留本站改动;缺省 true = 保留并按分组变动规则转换,false = 不保留(清空),全部跟新分组。 |
PUT
/api/v2/cache-sites/{id}/overlay保存站点的本站改动
鉴权: 用户(部分参数仅管理员)
请求体 application/json
| 字段 | 类型 | 说明 |
|---|---|---|
expected_updated_at | string | 乐观锁(修改时用):调用方读到的站点 updated_at。与库里当前值不等则回 409 stale_version、不保存;不带则不检查;创建时忽略。 |
overlay必填 | object | 本站改动;null = 没有。 |
DELETE
/api/v2/cache-sites/{id}/overlay站点全部还原为分组原样
鉴权: 用户(部分参数仅管理员)
GET
/api/v2/cache-sites/{id}/switch-preview预览站点换缓存分组后的规则
鉴权: 用户(部分参数仅管理员)
查询参数
| 字段 | 类型 | 说明 |
|---|---|---|
group_id | integer | 目标缓存分组 id(平台分组或站点属主的);不带 = 按默认分组。 |
keep | boolean | 是否保留本站改动,缺省 true;false = 不保留,全部跟新分组。 |
站点缓存分组与本站改动对象
| 字段 | 类型 | 说明 |
|---|---|---|
counts | object | 换后的汇总条数。 |
effective | CacheConfig | 缓存规则,同节点契约 schema/site.json 的 cache({rules, ignore_params}),服务端按契约校验。 |
effective_group_id | integer | 实际生效的分组;null = 没有可用分组(按出厂标配,不下发分组规则)。 |
expected_updated_at | string | 乐观锁(修改时用):调用方读到的站点 updated_at。与库里当前值不等则回 409 stale_version、不保存;不带则不检查;创建时忽略。 |
group_id | integer | 显式引用的分组;null = 按默认分组。 |
group_ignore_params | string[] | 换后分组自己的忽略参数清单。 |
group_name | string | 换后生效分组的名称;没有可用分组时省略。 |
ignore_params | string[] | 换后生效的忽略参数清单。 |
ignore_params_changed | boolean | 忽略参数清单是否是本站值(与分组不同)。 |
keep | boolean | 换分组时是否保留本站改动;缺省 true = 保留并按分组变动规则转换,false = 不保留(清空),全部跟新分组。 |
overlay | object | 本站改动;null = 没有。 |
overlay_count | integer | 改了几条:规则改动数 + 忽略参数改了算 1。 |
rows | CacheSwitchRow[] | 逐条规则,按显示顺序;删除行排在分组里的原位置。 |
site_id | integer | 网站 ID |
updated_at | string | 站点的 updated_at(站点行的版本,换分组或改本站改动也会更新);写入时作 expected_updated_at 带回。 |
返回与错误
成功直接回资源 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"
}