일반 API 데이터 소스에서 위젯 작성
일반 API를 사용하여 IBM® QRadar® API및 노출된 API가 있는 QRadar 앱에서 데이터를 페치하는 위젯을 작성할 수 있습니다.
이 태스크에 대한 정보
API는 JSON 배열 (여러 결과가 있는 경우) 또는 JSON 오브젝트 (하나의 결과만 있는 경우) 를 리턴합니다. 리턴된 JSON 오브젝트는 하나의 요소를 포함하는 JSON 배열로 변환됩니다.
프로시저
- 대시보드 구성을 클릭하십시오.
대시보드 구성 화면은 각 위젯에 대한 세부사항과 함께 사용 가능한 위젯의 라이브러리를 표시합니다.
- 새 위젯 작성을 클릭하십시오.
- 새 대시보드 항목 페이지에서 위젯에 대한 이름 및 설명을 입력하십시오.
- 조회 섹션의 데이터 소스 목록에서 일반 API 를 선택하고 다음 예제 중 하나와 같은 API 엔드포인트를 입력하십시오.
/api/asset_model/assets/api/health_data/top_rules/api/config/deployment/hosts/api/config/event_sources/log_source_management/log_sources/console/plugins/<QDI_appId>/app_proxy/comp_status_feed?timediff=471( 결과 맵핑에 data 입력).참고 : QDI 버전마다 URL 변경될 수 있습니다.
자세한 정보는 대시보드 차트에 대한 일반 API 조회 작성을 위한 팁의 내용을 참조하십시오.
- 선택사항: 일반 API 조회에 매개변수를 추가하십시오.
- 명령문에 기존 매개변수를 삽입하십시오. 매개변수 삽입 아이콘을 클릭한 다음 각 관련 매개변수에 대해 삽입을 클릭하십시오.
- 매개변수의 기본값을 변경하려면 매개변수 보기 아이콘을 클릭하고 기본값을 설정한 후 저장 을 클릭하십시오.매개변수의 기본값을 변경하면 확장되거나 고정된 대시보드 및 위젯을 제외하고 작업공간에서 매개변수가 사용되는 모든 위치에서 값이 변경됩니다. 값을 기본값으로 설정하지 않으면 업데이트된 변경사항이 현재 세션에만 적용됩니다. 그러나 값을 기본값으로 설정하면 현재 세션 값도 해당 값을 사용합니다.
사전 정의된 SYSTEM:username 매개변수는 로그인한 사용자의 사용자 이름을 리턴합니다. 시스템 매개변수는 읽기 전용이며 기본값을 변경할 수 없습니다.
- 작업공간에 매개변수를 추가하려면 추가를 클릭하고 필요한 경우 매개변수에 이름 및 기본값을 제공한 후 저장을 클릭하십시오.
처음으로 대시보드의 위젯에 매개변수를 추가한 후에는 매개변수 카드가 대시보드에 표시됩니다. 위젯에서 매개변수를 제거하고 해당 대시보드의 다른 위젯에서 매개변수를 사용하지 않으면 매개변수 카드가 사라집니다.
- 데이터 소스를 폴링하는 빈도에 대한 새로 고치기 시간을 선택하십시오. 기본 새로 고치기 시간은 5분마다입니다. 새로 고치기 시간이 짧을수록 IBM QRadar에 대한 성능 영향이 커집니다. 조회가 완료된 후 새로 고치기 시간이 시작됩니다.예를 들어 조회를 완료하는 데 3분이 걸리면 새로 고치기 시간은 3분 실행이 끝난 후에만 시작됩니다.
- 리턴된 JSON의 루트 오브젝트가 구성할 배열이 아닌 경우 결과 맵핑 을 입력하여 구성할 관련 데이터를 포함하는 키를 정의하십시오. 자세한 정보는 대시보드 차트에 대한 일반 API 조회 작성 팁을 참조하십시오.
- 선택사항: 리턴된 JSON에 제목 맵핑이 포함된 경우 결과 세트의 제목 사용 을 On으로 설정하십시오. 자세한 정보는 대시보드 차트에 대한 일반 API 조회 작성 팁을 참조하십시오.
- 조회 실행을 클릭하십시오.위젯을 처음 작성할 때 데이터 결과가 리턴되지 않으면 차트를 구성할 수 없습니다. 필드의 기준을 덜 엄격하게 만들고 조회를 다시 실행하십시오.
- 보기 섹션에서 대시보드 차트를 작성하십시오. 동일한 조회에서 여러 보기와 차트를 작성할 수 있으므로 보기에 고유한 이름을 지정하십시오. 기본적으로 제목 표시줄에 차트의 제목과 상태가 표시됩니다. 숨기려면 추가 옵션 아이콘을 클릭하고 설정을 끄기로 전환하십시오.
- 차트 유형을 선택하고 관련 특성을 구성하십시오. 사용할 차트 유형을 결정하는 데 도움이 되는 유스 케이스는 위젯 차트 유형을 참조하십시오.
차트 유형 지시사항 막대형 막대형 차트 작성 큰 숫자 큰 수치 차트 작성 지리적 지리적 차트 작성 원형 원형 차트 작성 산점도 분산형 차트 작성 표 형식 테이블형 차트 작성 시계열 시계열 차트 작성 - 차트의 모양을 미리 본 후 저장을 클릭하십시오.팁: 차트의 레이블은 사용되는 조회에서 나옵니다. 미리보기에서 이해할 수 없는 경우 보기 섹션의 레이블을 편집하십시오.