更新时间:2025-08-11 GMT+08:00

列举用户规则列表

功能介绍

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

URI

GET /v1/{project_id}/applications/{application_id}/uni-search/rule-regex

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,获取方法请参见获取项目ID

约束限制:

不涉及

取值范围:

1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。

默认取值:

不涉及

application_id

String

参数解释:

应用ID,获取方法请参见获取应用ID

约束限制:

字符串

取值范围:

1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

rules

Array of RuleRegexInfo objects

参数解释:

已配置的规则解析列表。

取值范围:

不涉及

表4 RuleRegexInfo

参数

参数类型

描述

id

String

参数解释:

规则ID。

取值范围:

不涉及

regexs

Array of strings

参数解释:

用户自定义规则内容。

取值范围:

不涉及

project_id

String

参数解释:

项目ID。

取值范围:

不涉及

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

取值范围:

不涉及

error_msg

String

参数解释:

错误描述。

取值范围:

不涉及

状态码:500

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

取值范围:

不涉及

error_msg

String

参数解释:

错误描述。

取值范围:

不涉及

请求示例

列举用户规则列表实例。

/v1/b25446daeb1a41a7953c5deba2b2677a/applications/cefb2a59-2f9e-4268-b56b-eab15dc0b9d6/uni-search/rule-regex

响应示例

状态码:200

用户定义规则列表。

{
  "rules" : [ {
    "id" : "default-rule-1",
    "project_id" : "",
    "regexs" : [ "^第([零〇一二三四五六七八九十百千万1-9]{1,7})章", "^第([零〇一二三四五六七八九十百千万1-9]{1,7})节", "^第([零〇一二三四五六七八九十百千万1-9]{1,7})条" ]
  }, {
    "id" : "1825365053436710914",
    "project_id" : "b25446daeb1a41a7953c5deba2b2677a",
    "regexs" : [ "^第([零〇一二三四五六七八九十百千万1-9]{1,7})章", "^第([零〇一二三四五六七八九十百千万1-9]{1,7})节", "^第([零〇一二三四五六七八九十百千万1-9]{1,7})条" ]
  }, {
    "id" : "1825444775541723137",
    "project_id" : "b25446daeb1a41a7953c5deba2b2677a",
    "regexs" : [ "^第([零〇一二三四五六七八九十百千万1-9]{1,7})章", "^(\\d+)(\\.)\\s*[\\u4e00-\\u9fa5]+$", "^(\\d+)(\\.\\d+)\\s*[\\u4e00-\\u9fa5]+$", "^(\\d+)(\\.\\d+)(\\.\\d+)\\s*[\\u4e00-\\u9fa5]+$" ]
  }, {
    "id" : "1846457265960275969",
    "project_id" : "b25446daeb1a41a7953c5deba2b2677a",
    "regexs" : [ "^第333([零〇一二三四五六七八九十百千万1-9]{1,7})章", "^第([零〇一二三四五六七八九十百千万1-9]{1,7})节", "^第([零〇一二三四五六七八九十百千万1-9]{1,7})条" ]
  }, {
    "id" : "1868588283685076994",
    "project_id" : "b25446daeb1a41a7953c5deba2b2677a",
    "regexs" : [ "^第([零〇一二三四五六七八九十百千万1-9]{1,7})章", "^第([零〇一二三四五六七八九十百千万1-9]{1,7})条" ]
  }, {
    "id" : "1875103496942211074",
    "project_id" : "b25446daeb1a41a7953c5deba2b2677a",
    "regexs" : [ "^第([零〇一二三四五六七八九十百千万1-9]{1,7})章", "^([一二三四五六七八九十]{1,7})、", "^(([一二三四五六七八九十]{1,7}))", "^(1-9)(.)", "^((1-9))(.)" ]
  }, {
    "id" : "1911702996365717505",
    "project_id" : "b25446daeb1a41a7953c5deba2b2677a",
    "regexs" : [ "^第([零〇一二三四五六七八九十百千万1-9]{1,7})章", "^第([零〇一二三四五六七八九十百千万1-9]{1,7})条" ]
  }, {
    "id" : "1911709287901409282",
    "project_id" : "b25446daeb1a41a7953c5deba2b2677a",
    "regexs" : [ "^第([零〇一二三四五六七八九十百千万1-9]{1,7})章", "^第([零〇一二三四五六七八九十百千万1-9]{1,7})条" ]
  }, {
    "id" : "1912398708489379841",
    "project_id" : "b25446daeb1a41a7953c5deba2b2677a",
    "regexs" : [ "^第([零〇一二三四五六七八九十百千万1-9]{1,7})章", "^第([零〇一二三四五六七八九十百千万1-9]{1,7})条" ]
  } ]
}

状态码

状态码

描述

200

用户定义规则列表。

400

请求体参数错误。

500

内部异常。

错误码

请参见错误码