Admin API 参考手册

Fess Admin API是用于通过程序访问管理功能的RESTful API。

概述

Admin API 概述

• 概述
• 基础URL
• 认证
• 通用模式
• 响应格式
• 可用API
• 使用示例
• 参考信息

爬虫设置

WebConfig API

• 概述
• 基础URL
• 端点列表
• 获取Web爬虫设置列表
• 获取Web爬虫设置
• 创建Web爬虫设置
• 更新Web爬虫设置
• 删除Web爬虫设置
• URL模式示例
• 使用示例
• 参考信息

FileConfig API

• 概述
• 基础URL
• 端点列表
• 获取文件爬虫设置列表
• 获取文件爬虫设置
• 创建文件爬虫设置
• 更新文件爬虫设置
• 删除文件爬虫设置
• 路径格式
• 使用示例
• 参考信息

DataConfig API

• 概述
• 基础URL
• 端点列表
• 获取数据存储设置列表
• 获取数据存储设置
• 创建数据存储设置
• 更新数据存储设置
• 删除数据存储设置
• 处理器类型
• 使用示例
• 参考信息

索引管理

Documents API

• 概述
• 基础URL
• 认证
• 端点列表
• 文档批量注册
• 使用示例
• 参考信息

CrawlingInfo API

• 概述
• 基础URL
• 端点列表
• 获取爬虫信息列表
• 获取爬虫信息
• 删除爬虫信息
• 批量删除爬虫会话
• 使用示例
• 参考信息

FailureUrl API

• 概述
• 基础URL
• 端点列表
• 获取失败URL列表
• 获取失败URL
• 删除失败URL
• 删除所有失败URL
• 错误类型
• 使用示例
• 参考信息

Backup API

• 概述
• 基础URL
• 认证
• 端点列表
• 获取备份对象列表
• 下载备份文件
• 使用示例
• 参考信息

调度器

Scheduler API

• 概述
• 基础URL
• 端点列表
• 获取计划任务列表
• 获取计划任务
• 创建计划任务
• 更新计划任务
• 删除计划任务
• 启动任务
• 停止任务
• 使用示例
• 参考信息

JobLog API

• 概述
• 基础URL
• 端点列表
• 获取作业日志列表
• 获取作业日志
• 删除作业日志
• 使用示例
• 参考信息

用户和权限管理

User API

• 概述
• 基础URL
• 端点列表
• 获取用户列表
• 获取用户
• 创建用户
• 更新用户
• 删除用户
• 使用示例
• 参考信息

Role API

• 概述
• 基础URL
• 端点列表
• 获取角色列表
• 获取角色
• 创建角色
• 更新角色
• 删除角色
• 使用示例
• 参考信息

Group API

• 概述
• 基础URL
• 端点列表
• 获取组列表
• 获取组
• 创建组
• 更新组
• 删除组
• 使用示例
• 参考信息

AccessToken API

• 概述
• 基础URL
• 端点列表
• 获取访问令牌列表
• 获取访问令牌
• 创建访问令牌
• 更新访问令牌
• 删除访问令牌
• 使用示例
• 参考信息

搜索调优

LabelType API

• 概述
• 基础 URL
• 端点列表
• 获取标签类型列表
• 获取标签类型
• 创建标签类型
• 更新标签类型
• 删除标签类型
• 使用示例
• 参考信息

KeyMatch API

• 概述
• 基础URL
• 端点列表
• 获取关键词匹配列表
• 获取关键词匹配
• 创建关键词匹配
• 更新关键词匹配
• 删除关键词匹配
• 使用示例
• 参考信息

BoostDoc API

• 概述
• 基础URL
• 认证
• 端点列表
• 获取文档提升列表
• 获取文档提升
• 创建文档提升
• 更新文档提升
• 删除文档提升
• 关于条件表达式与提升值表达式
• 使用示例
• 参考信息

ElevateWord API

• 概述
• 基础URL
• 端点列表
• 获取提升词列表
• 获取提升词
• 创建提升词
• 更新提升词
• 删除提升词
• 上传提升词CSV
• 下载提升词CSV
• 使用示例
• 参考信息

BadWord API

• 概述
• 基础URL
• 端点列表
• 获取屏蔽词列表
• 获取屏蔽词
• 创建屏蔽词
• 更新屏蔽词
• 删除屏蔽词
• 上传屏蔽词CSV
• 下载屏蔽词CSV
• 使用示例
• 参考信息

RelatedContent API

• 概述
• 基础URL
• 端点列表
• 获取相关内容列表
• 获取相关内容
• 创建相关内容
• 更新相关内容
• 删除相关内容
• 使用示例
• 参考信息

RelatedQuery API

• 概述
• 基础URL
• 端点列表
• 获取相关查询列表
• 获取相关查询
• 创建相关查询
• 更新相关查询
• 删除相关查询
• 错误响应
• 使用示例
• 参考信息

Suggest API

• 概述
• 认证
• 基础URL
• 端点列表
• 获取建议词统计信息
• 删除所有建议词
• 删除来源于文档的建议词
• 删除来源于搜索查询的建议词
• 错误响应
• 使用示例
• 参考信息

系统

General API

• 概述
• 基础URL
• 端点列表
• 获取常规设置
• 更新常规设置
• 使用示例
• 参考信息

SystemInfo API

• 概述
• 基础URL
• 端点列表
• 获取系统信息
• 使用示例
• 参考信息

Stats API

• 概述
• 基础URL
• 端点列表
• 获取系统统计信息
• 使用示例
• 参考信息

Log API

• 概述
• 基础URL
• 认证
• 端点列表
• 获取日志文件列表
• 下载日志文件
• 使用示例
• 参考信息

Storage API

• 概述
• 基础URL
• 认证
• 端点列表
• 获取文件和目录列表
• 下载文件
• 删除文件
• 上传文件
• 错误
• 使用示例
• 参考信息

Plugin API

• 概述
• 基础URL
• 端点列表
• 插件信息字段
• 获取已安装插件列表
• 获取可安装插件列表
• 安装插件
• 删除插件
• 使用示例
• 参考信息

词典

Dict API

• 概述
• 基础URL
• 端点列表
• 获取词典列表
• 获取词典项目列表
• 获取词典项目
• 创建词典项目
• 更新词典项目
• 删除词典项目
• 上传词典文件
• 下载词典文件
• 各词典类型的项目字段
• 使用示例
• 参考信息

搜索日志

SearchList API

• 概述
• 基础URL
• 认证
• 端点列表
• 搜索文档
• 获取文档
• 创建文档
• 更新文档
• 按ID删除文档
• 按查询删除文档
• 状态码
• 使用示例
• 参考信息