Meilisearch 使用以下标准 HTTP 状态码来表示 API 请求的成功或失败:

状态码描述
200成功 一切按预期执行
201已创建 资源已成功创建(同步操作)
202已接受 任务已加入队列(异步操作)
204无内容 资源已被删除或未返回任何内容
205重置内容 所有资源已被删除
400错误请求 请求不可接受,通常由于缺少必要参数
401未授权 未提供有效的 API 密钥
403禁止访问 API 密钥没有执行该请求的权限
404未找到 请求的资源不存在

错误处理

所有详细的任务响应都包含一个 error 字段。当任务失败时,总会伴随一个 JSON 格式的错误响应。Meilisearch 的错误可能属于以下类型之一:

类型描述
invalid_request由于用户输入错误导致。伴随 HTTP 状态码 4xx
internal由于机器或配置限制导致。伴随 HTTP 状态码 5xx
auth此类错误与认证和授权相关。伴随 HTTP 状态码 4xx
system表示系统已达到或超过磁盘容量、索引大小、打开文件数的限制,或数据库没有读写权限。伴随 HTTP 状态码 5xx

错误格式

{
  "message": "索引 `movies` 未找到。",
  "code": "index_not_found",
  "type": "invalid_request",
  "link": "https://docs.meilisearch.com/errors#index_not_found"
}
字段描述
message人类可读的错误描述
code错误代码
type返回错误的类型
link文档相关章节的链接

如果您在理解错误时遇到困难,请查看完整的错误代码列表及其描述。

测试响应字段组件

message
string

人类可读的错误描述

code
string
type
string

返回错误的类型

文档相关章节的链接