概览

API错误:响应代码和request_id

当API NN Agent拒绝时,它会返回一个包含错误描述和请求标识符的JSON。

{
  "error": { "code": "unauthorized", "message": "Missing bearer token" },
  "request_id": "f04e847d-8505-4b7b-a5c8-7aee42a8fc55"
}

request_id字段#

request_id — 特定调用的唯一标识符。请在您的一侧记录它:支持团队通过它在日志中找到请求,而无需询问时间、主体和标题。没有它,解析一个失败的调用将变成一天的往返通信。

响应代码#

代码 何时发生 该怎么办
200 请求已完成
401 标题 Authorization 缺失或令牌无效或已过期 检查授权
404 地址不存在。响应格式不同: {"detail":"Not Found"} 核对路径和版本与参考文档
422 主体或参数未通过验证 请参见 detail — 其中列出了哪个字段以及为什么被拒绝

验证错误表单#

响应 422 包含问题字段的列表:每个字段都指明了请求中的位置 (loc)、消息 (msg) 和错误类型 (type)。

{
  "detail": [
    { "loc": ["body", "field_name"], "msg": "field required", "type": "value_error.missing" }
  ]
}

证书错误 — 不是 API 错误#

如果客户端在验证 TLS 证书时中断连接,则根本没有来自 API 的响应: api.nexifyneo.com 返回自签名证书。这样的故障没有代码,也没有 request_id,在 API 日志中查找是没有意义的。详细信息 — 已知限制

继续#

  • 认证 — 如何传递令牌。
  • API 概述 — 操作组成和版本差异。

Updated

API错误:响应代码和request_id — NN Agent