错误
错误处理
本页面概述了 Meilisearch 如何报告和格式化错误对象。
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 | 人类可读的错误描述 |
code | 错误代码 |
type | 返回错误的类型 |
link | 文档相关章节的链接 |
如果您在理解错误时遇到困难,请查看完整的错误代码列表及其描述。
测试响应字段组件
人类可读的错误描述
文档相关章节的链接