版本 2.4.7.20261116085428 · 最新

CC 规则 cc-rules

把匹配器与过滤器按序组合成的 CC 规则组,站点可选用其中一组。

点击任一接口,右侧显示对应的调用示例。

防护鉴权: 用户(部分参数仅管理员)6 个接口

鉴权

请求头带 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/cc-rules列出CC 规则组

鉴权: 用户(部分参数仅管理员)

查询参数

字段类型说明
pageinteger 页码,从 1 开始。
默认 1
page_sizeinteger 每页条数。
默认 20
sortstring 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。
tenant_idinteger 仅管理员可用:按租户过滤(格式错 422)。租户凭据调用时忽略,只返回本租户数据。
enabledboolean 按启用状态过滤。
namestring 按名称包含过滤。
ownerstring platform = 只看平台对象;tenant = 只看租户对象。
可选值 ["platform","tenant"]
POST/api/v2/cc-rules创建CC 规则组

鉴权: 用户(部分参数仅管理员)

请求体 application/json

字段类型说明
desstring 备注;不给则为空(修改时不给也清空,整体替换)。
enabledboolean 是否启用
默认 true
expected_updated_atstring 乐观锁,仅修改时用:调用方读到的 updated_at。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。新建时忽略。
items必填CcRuleItem[] 规则条目,按序执行;条数受配置 protect.cc_rule_items_max 约束。
name必填string 名称
show_tointeger[] 平台规则组的可见租户;空 = 所有租户可见,非空只有列出的租户能看到、能在站点 cc_level 选它。只返回给管理员。
sortinteger 面板排序(小的在前)。
tenant_idinteger 所属租户;null = 平台对象(内置或管理员建,租户只读)。
visibleboolean 在站点的规则组下拉里展示。
默认 true
POST/api/v2/cc-rules/batch-enable批量启用或禁用CC规则组

鉴权: 用户(部分参数仅管理员)

请求体 application/json

字段类型说明
enabled必填boolean 是否启用
默认 true
ids必填integer[] 要改的对象 id,至多 100 个。
GET/api/v2/cc-rules/{id}获取CC 规则组

鉴权: 用户(部分参数仅管理员)

PUT/api/v2/cc-rules/{id}修改CC 规则组

鉴权: 用户(部分参数仅管理员)

请求体 application/json

字段类型说明
desstring 备注;不给则为空(修改时不给也清空,整体替换)。
enabledboolean 是否启用
默认 true
expected_updated_atstring 乐观锁,仅修改时用:调用方读到的 updated_at。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。新建时忽略。
items必填CcRuleItem[] 规则条目,按序执行;条数受配置 protect.cc_rule_items_max 约束。
name必填string 名称
show_tointeger[] 平台规则组的可见租户;空 = 所有租户可见,非空只有列出的租户能看到、能在站点 cc_level 选它。只返回给管理员。
sortinteger 面板排序(小的在前)。
tenant_idinteger 所属租户;null = 平台对象(内置或管理员建,租户只读)。
visibleboolean 在站点的规则组下拉里展示。
默认 true
DELETE/api/v2/cc-rules/{id}删除CC 规则组

鉴权: 用户(部分参数仅管理员)

CC 规则对象

字段类型说明
builtinboolean 内置对象,不可删。
只读
created_atstring 创建时间
只读
desstring 备注;不给则为空(修改时不给也清空,整体替换)。
enabledboolean 是否启用
默认 true
errorsFieldError[] 没改的逐条原因;field 为 /ids/<下标>,code 同单条修改接口(not_found、readonly 等)。
expected_updated_atstring 乐观锁,仅修改时用:调用方读到的 updated_at。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。新建时忽略。
idinteger 记录 ID
只读
ids必填integer[] 要改的对象 id,至多 100 个。
itemsCcRuleItem[] 规则条目,按序执行;条数受配置 protect.cc_rule_items_max 约束。
namestring 名称
ruleset_idstring 编译成的规则集 id:平台 cc.level.<名>(站点 cc_level、guard.default_cc_level 引用它);租户 cc.user.r<id>(本租户站点的 cc_level 可选它,带套餐的站点须套餐有 custom_cc_rule)。
只读
show_tointeger[] 平台规则组的可见租户;空 = 所有租户可见,非空只有列出的租户能看到、能在站点 cc_level 选它。只返回给管理员。
sortinteger 面板排序(小的在前)。
tenant_idinteger 所属租户;null = 平台对象(内置或管理员建,租户只读)。
只读
updatedinteger[] 已改好的 id(含本来就是目标状态的),按请求顺序。
updated_atstring 更新时间
只读
visibleboolean 在站点的规则组下拉里展示。
默认 true

返回与错误

成功直接回资源 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"
}
开始使用

123

123