版本 2.4.7.20261116085428 · 最新
缓存策略 cache-policy
设置本租户的默认缓存分组,并可把全部站点改回按默认分组。
点击任一接口,右侧显示对应的调用示例。
缓存鉴权: 用户(部分参数仅管理员)4 个接口
鉴权
请求头带 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-policy缓存策略
鉴权: 用户(部分参数仅管理员)
查询参数
| 字段 | 类型 | 说明 |
|---|---|---|
tenant_id | integer | 仅管理员可用:按租户过滤(格式错 422)。租户凭据调用时忽略,只返回本租户数据。 |
PUT
/api/v2/cache-policy设本租户的默认分组
鉴权: 用户(部分参数仅管理员)
请求体 application/json
| 字段 | 类型 | 说明 |
|---|---|---|
default_group_id必填 | integer | 平台默认分组;null = 还没有分组。 |
GET
/api/v2/cache-policy/default-impact预检改默认分组的影响
鉴权: 用户(部分参数仅管理员)
查询参数
| 字段 | 类型 | 说明 |
|---|---|---|
tenant_id | integer | 仅管理员可用:按租户过滤(格式错 422)。租户凭据调用时忽略,只返回本租户数据。 |
default_group_id必填 | integer | 打算设为默认的缓存分组 id。 |
POST
/api/v2/cache-policy/reset-sites全部站点改回按默认分组
鉴权: 用户(部分参数仅管理员)
缓存策略对象
| 字段 | 类型 | 说明 |
|---|---|---|
affected_sites | integer | 跟默认的站点数:没显式引用分组、改默认后生效分组会变的站。 |
applied | integer | 已改回的站点数。 |
default_group_id | integer | 平台默认分组;null = 还没有分组。 |
my_default_group_id | integer | 本租户生效的默认分组(自己设的,没设为平台默认)。 |
my_default_group_set | boolean | 本租户自己设过默认分组。 |
over_limit_sites | integer | 其中转换后合成超过 128 条、真正修改会 422 的站点数。 |
overlay_sites | integer | 其中带本站改动、会随之转换的站点数。 |
sites | object | 本租户站点数:total 全部网站,overlay 其中有本站改动的网站,follow_default 其中缓存分组跟随默认的网站(未指定分组,或指定的正是租户生效的默认分组;与是否有本站改动无关)。 |
返回与错误
成功直接回资源 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"
}