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

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

다음 표에서는 HTTP 응답 오류 범주에 대한 자세한 정보를 제공합니다 IBM® QRadar® REST API: