文档首页/ 华为云Flexus云服务_Flexus企业搜索服务/ API参考/ 用户的文档解析规则定义/ 列举用户规则列表
更新时间：2024-08-27 GMT+08:00
查看PDF
分享

列举用户规则列表

功能介绍

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

URI

GET /v1/koosearch/rule-regex

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：1

最大长度：1000000

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

rules

Array of RuleRegexInfo objects

已配置的规则解析列表

数组长度：0 - 65535
表3 RuleRegexInfo

参数

参数类型

描述

id

String

规则ID

最小长度：1

最大长度：65535

rule_regexs

Array of strings

用户自定义规则内容

最小长度：1

最大长度：65535

数组长度：1 - 65535

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：36

error_msg

String

错误描述

最小长度：2

最大长度：512

状态码： 500

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：36

error_msg

String

错误描述

最小长度：2

最大长度：512

请求示例

无

响应示例

状态码： 200

用户定义规则列表

{
  "rules" : [ {
    "id" : "string",
    "rule_regexs" : [ "string" ]
  } ]
}

状态码

状态码

描述

200

用户定义规则列表

400

请求体参数错误

500

内部异常

错误码

请参见错误码。

相关文档