API 錯誤訊息

當 API 要求因要求錯誤或伺服器錯誤而失敗時，會以 JSON 格式傳回錯誤回應訊息。

即使端點支援其他 MIME 類型，也會以 JSON 格式傳回錯誤回應訊息。 錯誤回應訊息包括錯誤訊息本身、錯誤說明、端點的唯一錯誤碼、HTTP 回應訊息及 HTTP 回應碼。

錯誤回應包括下列欄位:

• message: 錯誤訊息
• details: 其他資訊的欄位，不一定會移入資料
• description: 特定錯誤的說明
• code: 唯一錯誤回應碼
• http_response:
  • message:HTTP 回應訊息
  • code:HTTP 回應狀態碼

例如，下列 API 要求會嘗試取得稱為 "test-set" 之不存在參照集的相關資訊:

https://<host_ip>/api/reference_data/sets/test_set

HTTP404會傳回回應碼及下列 JSON 錯誤回應訊息:

{
  "message": "test_set does not exist",
  "details": {},
  "description": "The reference set does not exist.",
  "code": 1002,
  "http_response": {
     "message": "We could not find the resource you requested.",
      "code": 404
   }
}

下表提供 IBM® QRadar ® REST API 所傳回 HTTP 回應錯誤種類的相關資訊: