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
   }
}

次の表は、REST API が返す HTTP レスポンス・エラー・カテゴリの詳細です。 IBM® QRadar® REST API によって返されるレスポンス・エラーのカテゴリの詳細を示します：