Cato API - auditFeed

Cato API 지원 정책을 사용하기 전에 반드시 검토하시기 바랍니다.

auditFeed 개요

auditFeed 쿼리는 Cato 관리 애플리케이션에서 관리자가 수행한 작업을 분석하는 데 도움을 줍니다. 이 쿼리가 반환하는 데이터는 Cato 관리 애플리케이션의 System> 감사 기록 창과 유사합니다.

리셀러 계정의 경우, Cato API에 연결할 고객 계정 내에서 별도의 API 키를 생성할 수 있습니다. 속도 제한 및 auditFeed API 쿼리에 대한 자세한 내용은 Cato API 속도 제한 이해하기를 참조하세요.

가져온 데이터 이해하기

auditFeed API 호출은 시간당 2M 이상의 감사 데이터를 가져오는 것을 지원하도록 설계되었습니다. 반환된 데이터를 페이지 나누기 위해, 시간프레임 동안 1000개 이상의 감사 항목이 있는 경우 쿼리는 모든 감사 데이터를 반환할 때까지 가져오기를 반복합니다.

다음 필드는 감사 데이터의 페이징과 관련이 있습니다: marker, fetchedCount, hasMore. 이 필드에 대한 설명은 아래를 참조하십시오.

auditFeed 필드에 대한 세부 정보

audFeed 필드가 쿼리에 대해 표시할 수 있는 세부 정보는 다음과 같습니다.

  • from - 시작 시간
  • to - 종료 시간
  • marker - API 쿼리가 반환한 마지막 감사 데이터 항목의 고유 식별자입니다.
  • fetchedCount - 가져온 항목 수 (최대 1000개 항목당 가져오기)
  • hasMore - 값이 true인 경우, 쿼리가 가져올 항목이 더 있음을 나타냅니다.
  • accounts (auditFeedAccountRecords) - 여러 계정을 관리하는 리셀러의 경우, 이 필드는 변경된 계정을 지정하고 모든 기록 및 감사 데이터를 포함합니다 (중첩 쿼리 및 필드가 있는 배열).

auditFeed From

From 필드는 쿼리 데이터의 시작 시간을 보여주며, timeFrame 인수에서 정의됩니다.

auditFeed To

To 필드는 쿼리 데이터의 종료 시간을 보여주며, timeFrame 인수에서 정의됩니다.

auditFeed Marker

마커 필드는 쿼리 기간 동안 감사 데이터 항목이 1000개 이상인 경우, 새 반복의 시작을 나타내는 식별자를 보여줍니다. 예를 들어 쿼리가 2500개의 항목을 반환하면, 가져오기 반복 동안의 결과는 다음과 같습니다.

  • 첫 번째 반복 - fetchedCount = 1000 (항목), marker = 1234abc, hasMore = true
  • 두 번째 반복 - fetchedCount = 1000 (항목), marker = 4567def, hasMore = true
  • 세 번째 반복 - fetchedCount = 500 (항목), marker = 8901xyz, hasMore = false

    마지막 반복에서는 marker 값을 무시할 수 있습니다.

auditFeed fetchedCount

fetchedCount 필드는 현재 가져오기 작업에서 총 항목 수를 보여줍니다. 이 필드의 최대 값은 1000입니다.

auditFeed hasMore

hasMore 필드의 값이 true이면, 이 이후에 항목을 가져오는 또 다른 반복이 있음을 의미합니다.

auditFeed 계정

이 쿼리에 대한 Accounts (auditFeedAccountRecords) 필드는 관리자 ID 및 감사 데이터를 보여줍니다. auditFeedAccountsRecords > AuditRecord > AuditFieldName 인수를 사용하여 쿼리에 대한 이벤트 데이터를 필터링하십시오. AuditRecords 필드에 대한 자세한 내용은 아래 auditFeed > fieldName > AuditFieldName을 참조하십시오.

auditFeed 인수

쿼리에 의해 반환되는 데이터를 정의하기 위해 전달할 수 있는 인수는 다음과 같습니다.

  • accountIDs - 계정 ID (여러 계정의 경우, 배열로 ID를 입력)
  • ids - 계정 ID (레거시 인수)
  • timeFrame - 쿼리의 시작 및 종료 시간
  • 필터 (AuditFieldFilterInput) - 쿼리된 감사 로그 데이터를 필터링 (중첩 쿼리가 있는 배열)
  • marker - 마커 값에 따라 특정 가져오기 반복에 대한 항목만 표시

auditFeed accountIDs 인수

쿼리에 반환될 데이터에 대한 하나 이상의 계정 ID를 입력하십시오. 이 인수는 필수적입니다.

이 계정 ID는 Cato 관리 애플리케이션에 표시되지 않으며, 대신 Cato 관리 애플리케이션의 URL에 있는 숫자입니다. 예를 들어, 계정 ID는 다음 URL의 경우 26입니다: https://cc2.catonetworks.com/#!/26/topology.

auditFeed timeFrame 인수

쿼리에 반환될 데이터의 시간 범위를 입력하십시오. 인수 형식은 <type>.<time value> 입니다.. 이 인수는 필수적입니다.

시간 범위를 정의하기 위해 지원되는 옵션은 다음과 같습니다.

  • last.<time duration> - last 유형의
  • <timezone>.<short-time-frame-spec> - 시간 범위는 지정된 시간대에 따라 YY-MM-DD/hh:mm:ss 형식으로 시작 및 종료 날짜를 결합합니다. 예를 들어, timeFrame = utc.2020-02-{11/04:50:00--21/04:50:00}은 2020년 2월 11일 오전 4시 50분부터 2020년 2월 21일 오전 4시 50분까지의 분석 데이터를 표시합니다.

auditFeed 필터 인수

필터 (AuditFieldFilterInput) 인수는 감사 추적 쿼리에 포함될 특정 항목을 정의할 수 있습니다. 정의할 수 있는 인수는 다음과 같습니다.

  • fieldName > AuditFieldName - 감사 추적에서 항목 정의
  • operator - 감사 데이터를 필터링할 값 활성화 방법 정의
  • values - 연산자와 함께 사용되는 필터 값 정의

auditFeed > fieldName > AuditFieldName

이는 System > 감사 추적에서 모니터링되는 다양한 Cato 관리 애플리케이션 구성의 필드 이름입니다.

  • admin - 기록을 생성한 관리자의 작업
  • model_name - 예시: My Site와 같은 영향을 받은 객체의 이름
  • admin_id - 기록을 생성한 관리자의 ID
  • module - 변경된 시스템 모듈, 예를 들어 MFA 구성 또는 TLS 검사
  • insertion_date - 변경이 커밋되거나 저장된 시간
  • change_type - 관리자가 수행한 변경을 설명하며, 값은 다음과 같습니다: CREATED, DELETED, MODIFIED, ENABLED, DISABLED, SKIPPED
  • creation_date - 변경이 시작된 시간
  • change - JSON 형식의 변경에 대한 상세한 설명
  • model_type - 예를 들어 Site, Socket, SocketInterface와 같이 변경된 객체의 유형

auditFeed 마커 인수

마커 인수는 특정 가져오기 반복에 대한 이벤트로 쿼리를 제한할 수 있습니다. 마커 값을 표시하려면 빈 값으로 마커 인수를 사용하여 쿼리를 실행하십시오. 쿼리는 정의된 timeFrame 인수에 대한 마커 값을 반환합니다.

예를 들어, 쿼리가 2500개의 이벤트를 반환하면 첫 세 번의 가져오기 반복 동안의 결과는 다음과 같습니다.

  • 첫 번째 반복 - fetchedCount = 1000 (이벤트), marker = 1234abc, hasMore = true
  • 두 번째 반복 - fetchedCount = 1000 (이벤트), marker = 4567def, hasMore = true
  • 세 번째 반복 - fetchedCount = 1000 (이벤트), marker = 8901xyz, hasMore = true

두 번째 반복에서만 이벤트를 표시하려면, 마커 인수를 4567def로 설정하십시오.

도움이 되었습니까?

2명 중 0명이 도움이 되었다고 했습니다.

댓글 0개