CMDBQueryBuilderAPI - 전역

  • 릴리스 버전: Washingtondc
  • 업데이트 날짜 2024년 02월 01일
  • 읽기3분
  • CMDBQueryBuilderAPI는 서버 측 스크립트에서 쿼리 작성기에 저장된 쿼리 실행 상세 정보를 검색하는 메서드를 제공합니다.

    이 API에 액세스하려면 구성 관리(CMDB)(com.snc.cmdb) 플러그인을 활성화해야 합니다.

    CMBD 쿼리 작성기에 대한 자세한 내용은 CMDB 쿼리를 참조하십시오.

    CMDBQueryBuilderAPI - getSavedQueryExecutionDetails(savedQueryName 문자열, 부울 executeQuery, 숫자 시간 제한)

    지정된 구성 관리 데이터베이스(CMDB) 쿼리 작성기 저장된 쿼리에 대한 실행 상세 정보를 반환합니다.

    필요에 따라 가장 최근의 쿼리 실행 세부 정보를 반환하기 위해 쿼리를 실행할지 여부를 지정할 수 있습니다. 쿼리 실행에 대한 기본 제한 시간 제한을 재정의할 수도 있습니다.

    쿼리를 실행하는 동안 시간 초과 또는 메모리 문제가 발생하는 경우 쿼리 일괄 처리 크기를 미세 조정하여 이러한 문제를 완화할 수 있습니다. 자세한 내용은 Query Builder 저장된 쿼리의 배치 크기를 참조하세요.

    표 1. 매개변수
    이름 유형 설명
    executeQuery 부울 옵션입니다. 지정된 쿼리를 실행할지 여부를 나타내는 플래그입니다.

    유효한 값은 다음과 같습니다.

    • true: 지정된 쿼리를 실행하고 실행 상세 정보를 반환합니다.
    • false: 지정된 쿼리를 실행하지 않습니다. 쿼리의 가장 최근 실행 세부 정보를 반환합니다.

    기본값: False

    savedQueryName 문자열 쿼리 실행 상세 정보를 반환할 CMDB 쿼리 작성기 저장된 쿼리의 이름입니다.
    timeout 번호 옵션입니다. 기본 쿼리 실행 시간 제한 제한인 5분을 재정의하는 정수 값입니다.

    단위: 초

    기본값: 5분

    표 2. 반환
    유형 설명
    오류 오류 코드 및 메시지. 쿼리 실행이 실패하거나 지정된 쿼리를 찾을 수 없는 경우 반환됩니다.

    오류 예:

    • {"error": "QUERY_EXECUTION_NOT_FOUND", "message": "쿼리 실행 상세 정보를 찾을 수 없습니다. 쿼리를 실행하십시오."}
    • {"error": "QUERY_NOT_FOUND", "message": "주어진 저장된 쿼리를 찾을 수 없습니다. 저장된 쿼리의 이름을 전달하고 있는지 확인하십시오."}
    • {"error": "QUERY_EXECUTION_FAILED", "message": "쿼리 실행에 실패했습니다. 올바른 쿼리를 사용하십시오."}
    query_id 저장된 쿼리 실행 ID(sys_id)입니다. 쿼리 상태 [qb_query_status] 테이블에서 가져옵니다.
    table_name 실행 쿼리 상세 정보가 들어있는 테이블의 이름입니다.
    status 쿼리 실행의 상태입니다.
    • COMPLETE: 실행이 완료되었습니다.
    • FAILED: 쿼리 실행 중 오류가 발생했습니다.
    • TIME_OUT: 쿼리 실행 시간이 초과되었습니다.
    • MAX_LIMIT: 반환 결과의 최대 수에 도달했습니다.

    이 예제에서는 getSavedQueryExecutionDetails() 메서드를 호출하는 방법을 보여 줍니다.

    SNC.CMDBQueryBuilderAPI.getSavedQueryExecutionDetails('Test', true);
    

    출력:

    {"query_id":"024fd53a7773330033b5270bba106141",
    "table_name":"u_cmdb_qb_result_598918aacb4dbf3f1a8dcf03fce6a5d57151a4e2",
    "status":COMPLETE}

    이 예제에서는 getSavedQueryExecutionDetails() 메서드를 호출하고 기본 쿼리 실행 시간 제한 값을 10분으로 재정의하는 방법을 보여 줍니다.

    SNC.CMDBQueryBuilderAPI.getSavedQueryExecutionDetails('Test', true, 600);
    

    출력:

    {"query_id":"024fd53a7773330033b5270bba106141",
    "table_name":"u_cmdb_qb_result_598918aacb4dbf3f1a8dcf03fce6a5d57151a4e2",
    "status":COMPLETE}