Skip to content

接口与数据模型速查

本页汇总规则中心的 API、权限码、数据表、枚举和种子数据。字段以 packages\shared\src\rulespackages\server\src\db\schema\rules.ts 为准。

API 路径

决策表

方法路径说明
GET/api/rules/decision-tables分页列表
GET/api/rules/decision-tables/{id}详情
POST/api/rules/decision-tables创建
PUT/api/rules/decision-tables/{id}更新
DELETE/api/rules/decision-tables/{id}删除
DELETE/api/rules/decision-tables/batch批量删除
POST/api/rules/decision-tables/{id}/publish发布,可选灰度
POST/api/rules/decision-tables/{id}/toggle启用 / 停用
POST/api/rules/decision-tables/{id}/gray灰度转正 / 放弃
POST/api/rules/decision-tables/{id}/submit-review申请发布
POST/api/rules/decision-tables/{id}/review审批发布
POST/api/rules/decision-tables/{id}/test编辑态测试求值
POST/api/rules/decision-tables/evaluate按 key 手动求值
GET/api/rules/decision-tables/{id}/versions版本列表
GET/api/rules/decision-tables/{id}/diff版本对比
POST/api/rules/decision-tables/{id}/rollback/{version}回滚历史版本
GET/api/rules/decision-tables/{id}/usages引用分析
GET/api/rules/decision-tables/{id}/stats命中分析
POST/api/rules/decision-tables/{id}/shadow-run影子对比
POST/api/rules/decision-tables/{id}/simulate批量仿真
GET/api/rules/decision-tables/{id}/cases测试用例列表
POST/api/rules/decision-tables/{id}/cases新增测试用例
PUT/api/rules/decision-tables/{id}/cases/{caseId}更新测试用例
DELETE/api/rules/decision-tables/{id}/cases/{caseId}删除测试用例
POST/api/rules/decision-tables/{id}/cases/run批量运行用例

决策流

方法路径说明
GET/api/rules/decision-flows分页列表
GET/api/rules/decision-flows/{id}详情
POST/api/rules/decision-flows创建
PUT/api/rules/decision-flows/{id}更新
DELETE/api/rules/decision-flows/{id}删除
DELETE/api/rules/decision-flows/batch批量删除
POST/api/rules/decision-flows/{id}/publish发布
POST/api/rules/decision-flows/{id}/toggle启用 / 停用
POST/api/rules/decision-flows/{id}/test编辑态测试求值
POST/api/rules/decision-flows/evaluate按 key 手动求值
GET/api/rules/decision-flows/{id}/versions版本历史
POST/api/rules/decision-flows/{id}/rollback/{version}回滚历史版本

评分卡

方法路径说明
GET/api/rules/scorecards分页列表
GET/api/rules/scorecards/{id}详情
POST/api/rules/scorecards创建
PUT/api/rules/scorecards/{id}更新
DELETE/api/rules/scorecards/{id}删除
POST/api/rules/scorecards/{id}/publish发布
POST/api/rules/scorecards/{id}/toggle启用 / 停用
POST/api/rules/scorecards/{id}/evaluate编辑态测试求值
POST/api/rules/scorecards/evaluate-by-key按 key 运行时求值
GET/api/rules/scorecards/{id}/versions版本历史
POST/api/rules/scorecards/{id}/rollback/{version}回滚历史版本

名单库

方法路径说明
GET/api/rules/lists分页列表
POST/api/rules/lists/check命中检测
POST/api/rules/lists创建名单
PUT/api/rules/lists/{id}更新名单
DELETE/api/rules/lists/{id}删除名单
GET/api/rules/lists/{id}/usages引用分析
GET/api/rules/lists/{id}/items条目分页列表
POST/api/rules/lists/{id}/items新增条目
POST/api/rules/lists/{id}/items/batch批量导入条目
DELETE/api/rules/lists/{id}/items/{itemId}删除条目
POST/api/rules/lists/{id}/items/purge-expired清理过期条目

执行记录与开放平台

方法路径说明权限 / scope
GET/api/rules/executions规则执行记录分页rule:table:list
POST/api/open/v1/rules/evaluate开放平台统一求值rules:evaluate

权限码

菜单权限码说明
决策表rule:table:list查询决策表;执行记录页也复用该权限
决策表rule:table:create新增决策表
决策表rule:table:update编辑决策表、回滚、测试用例维护
决策表rule:table:delete删除决策表、批量删除
决策表rule:table:publish发布、启停、灰度操作、申请发布
决策表rule:table:evaluate求值测试、测试矩阵运行、仿真、影子对比
决策表rule:table:approve审批发布
决策流rule:flow:list查询决策流
决策流rule:flow:create新增决策流
决策流rule:flow:update编辑 / 回滚决策流
决策流rule:flow:delete删除 / 批量删除决策流
决策流rule:flow:publish发布 / 启停决策流
决策流rule:flow:evaluate决策流求值测试
名单库rule:list:list查询名单、条目与引用,执行名单检测
名单库rule:list:create新增名单
名单库rule:list:update编辑名单、启停
名单库rule:list:delete删除名单
名单库rule:list:item新增、批量导入、删除、清理名单条目
评分卡rule:scorecard:list查询评分卡与版本
评分卡rule:scorecard:create新增评分卡
评分卡rule:scorecard:update编辑、启停、回滚评分卡
评分卡rule:scorecard:delete删除评分卡
评分卡rule:scorecard:publish发布评分卡
评分卡rule:scorecard:evaluate评分卡求值测试
开放平台rules:evaluate调用开放平台统一求值

枚举值

枚举
资产类型 RuleRefKindtableflowscorecardlist
执行来源 RuleExecutionSourceruntimemanualtestopen
决策表命中策略 RuleHitPolicyfirstuniqueprioritycollectany
决策表状态 RuleDecisionStatusdraftpublisheddisabled
字段类型 RuleFieldTypestringnumberbooleandate
collect 聚合 RuleCollectAggregatelistsumminmaxcountdistinct
求值原因 RuleEvaluateReasonno_matchunique_conflictany_conflict
名单类型 RuleListTypeblackwhitegrey
名单匹配 RuleListMatchModeexactprefixregex
评分卡分段 RuleScorecardBandOprangeeqindefault

数据表

rule_decision_tables

字段说明
id主键
key租户内唯一资产键
name / description名称与描述
category_id工作流分类 ID,可为空
statusdraft / published / disabled
hit_policy命中策略
inputs / outputs / rules / settings决策表编辑态 JSON
version当前版本号
published_at发布时间
gray_percent / gray_dimension / gray_version灰度发布配置
review_status / review_requested_by / review_requested_at / review_comment发布审批状态
tenant_id租户 ID,空表示平台级
created_by / updated_by / created_at / updated_at审计字段

唯一约束:(tenant_id, key)

rule_decision_table_versions

字段说明
id主键
table_id决策表 ID
version快照版本
name / description快照名称与描述
hit_policy快照命中策略
inputs / outputs / rules / settings发布快照 JSON
published_at / published_by发布信息
tenant_id租户 ID

唯一约束:(table_id, version)

rule_test_cases

字段说明
id主键
table_id决策表 ID
name用例名称,表内唯一
input输入 JSON
expected期望输出 JSON
tenant_id租户 ID
created_by / updated_by / created_at / updated_at审计字段

唯一约束:(table_id, name)

rule_executions

字段说明
id主键
ref_kindtable / flow / scorecard / list
ref_id资产行 ID,可为空
rule_key资产 key
version求值版本,可为空
caller调用方标识
biz_ref业务关联对象
sourceruntime / manual / test / open
matched是否命中
hit_policy决策表命中策略,可为空
input / outputs / matched_row_ids输入、输出与命中行
created_by / tenant_id / created_at创建人与租户信息

索引:tenant_id(ref_kind, ref_id)callerbiz_ref

rule_asset_versions

字段说明
id主键
ref_kindflow / scorecard
ref_id资产 ID
version快照版本
snapshot发布快照 JSON
published_by / published_at发布信息
tenant_id租户 ID

唯一约束:(ref_kind, ref_id, version)

rule_decision_flows

字段说明
id主键
key租户内唯一资产键
name / description名称与描述
statusdraft / published / disabled
steps编辑态步骤 JSON
published_steps发布快照步骤 JSON
version / published_at版本与发布时间
tenant_id租户 ID
created_by / updated_by / created_at / updated_at审计字段

唯一约束:(tenant_id, key)

rule_lists

字段说明
id主键
key租户内唯一名单键
name / description名称与描述
typeblack / white / grey
statusenabled / disabled
tenant_id租户 ID
created_by / updated_by / created_at / updated_at审计字段

唯一约束:(tenant_id, key)

rule_list_items

字段说明
id主键
list_id名单 ID
value条目值
label条目标签
match_modeexact / prefix / regex
expires_at过期时间,可为空
remark备注
created_by / created_at创建信息

唯一约束:(list_id, value);索引:list_id

rule_scorecards

字段说明
id主键
key租户内唯一评分卡键
name / description名称与描述
statusdraft / published / disabled
base_score基础分
variables / grades编辑态变量与等级 JSON
published_snapshot发布快照 JSON
version / published_at版本与发布时间
tenant_id租户 ID
created_by / updated_by / created_at / updated_at审计字段

唯一约束:(tenant_id, key)

菜单种子

规则中心使用 6000 段菜单 ID:

ID标题路由 / 权限
6000规则中心目录
6010决策表/rules/tables
6020执行记录/rules/executions
6030决策流/rules/flows
6040名单库/rules/lists
6050评分卡/rules/scorecards

按钮权限见本页「权限码」。

内置资产种子

类型key名称说明
决策表member_level会员等级判定按累计消费金额输出等级与折扣
决策表payment_risk支付风控策略输出 actionreason,命中后接管支付风控裁决
决策表dispute_triage交易投诉分流输出 routepriorityslaHours
决策流member_benefit_flow会员权益决策流示例步骤引用 member_level
名单risk_blacklist风控黑名单会员认证、支付风控、CMS 提交共用
名单vip_whitelistVIP 白名单可信主体示例
名单cms_watchlistCMS 观察灰名单CMS 提交命中后标注观察
评分卡credit_score信用评分卡基础分 300,按年龄、城市等级、逾期次数打分

开放平台 scope 种子包含:rules:evaluate(规则求值)。

Built with VitePress for local documentation preview.