文档首页/ 云搜索服务 CSS_企业搜索服务 KooSearch/ API参考/ API/ 历史API/ 用户的文档解析规则定义/ 列举用户自定义规则列表
更新时间：2025-07-22 GMT+08:00
查看PDF
分享

列举用户自定义规则列表

功能介绍

列举用户配置的所有自定义解析规则列表。

URI

GET /v1/koosearch/rule-regex

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

接口鉴权使用的Token，Token获取方式参考：3.2节 认证鉴权。

约束限制：

不涉及。

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

rules

Array of RuleRegexInfo objects

已配置的规则解析列表。
表3 RuleRegexInfo

参数

参数类型

描述

id

String

规则ID。

regexs

Array of strings

用户自定义规则内容。

project_id

String

创建用户的project_id。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：500

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

无

响应示例

状态码：200

用户定义规则列表。

{
  "rules" : [ {
    "id" : "1849381761142775810",
    "regexs" : [ "^例.+$" ]
  }, {
    "id" : "1851107852563800066",
    "regexs" : [ "^(\\d+)\\s*[\\u4e00-\\u9fa5]+$", "^(\\d+)(\\.\\d+)\\s*[\\u4e00-\\u9fa5]+$", "^(\\d+)(\\.\\d+)(\\.\\d+)\\s*[\\u4e00-\\u9fa5]+$" ]
  } ]
}

状态码

状态码

描述

200

用户定义规则列表。

400

请求体参数错误

500

内部异常

错误码

请参见错误码。

相关文档