Audit Logs (그룹 및 조직) v1 API에서 GA REST Audit logs API 마이그레이션 가이드 검색
REST Search Audit Logs API의 새로운 기능
OpenAPI 사양을 기반으로 하는 Snyk REST API는 일관되고 친숙하며 사용하기 쉬운 API 프레임워크를 제공하도록 설계되었으며 몇 가지 주요 개선 사항을 도입했습니다. 새로운 API의 장점은 다음과 같습니다.
일관된 버전 관리
성능 향상
Search Audit Logs REST API는 더 우수한 성능과 일관성을 제공하는 커서 기반(cursor-based) 페이지네이션을 위해 오프셋 기반(offset-based) 페이지네이션을 지원 종료(deprecated)했습니다. v1 API는 페이지 오프셋이 높아질수록 속도가 느려지고 결과적으로 매우 높은 페이지 수에서는 타임아웃이 발생할 수 있습니다. REST API에서는 페이지 수에 관계없이 일관되게 빠른 속도로 결과를 반환하는 커서 기반 방식을 사용하여 이를 대폭 개선했습니다.
성능 향상뿐만 아니라 필터링 기능도 개선되어 사용자가 더 세밀한 필터링을 위해 여러 개의 포함 또는 제외 이벤트를 제공할 수 있습니다. 또한, 기존 API는 최소 24시간 단위로만 로그를 검색할 수 있었으나, RFC3339 고정밀 타임스탬프를 도입하여 특정 날짜의 분 단위 창 내에서 검색할 수 있도록 개선했습니다.
`api.access` 로그는 이제 events 매개변수의 일부로 명시적으로 제공되지 않는 한 모든 검색 쿼리에서 기본적으로 제외됩니다. 이러한 로그는 일반적으로 정보량은 적고 양은 많으며, group.create와 같은 명시적인 작업 로그에 의해 대체됩니다. 명시적인 작업 로그에는 작업에 대한 풍부한 컨텍스트 정보가 포함되어 있으므로 모든 경우에 이를 우선적으로 사용하는 것이 좋습니다.
다음은 v1 엔드포인트에서 사용할 수 있었던 항목과 그에 해당하는 GA REST 대체 항목입니다.
(query) page (Number)
(query) cursor (string)
(query) sortOrder
변경 없음
(body) filters.userId (string)
(query) user_id (string)
요청 본문에서 쿼리 매개변수로 이동
(body) filters.email (string)
지원 종료 (deprecated)
사용자 피드백을 기반으로 제거됨
(body) filters.event (string)
(query) events (쉼표로 구분된 목록)
매개변수 이름 변경 및 쿼리로 이동. 다중 값 지원.
(body) filters.excludeEvent (string)
(query) exclude_events (쉼표로 구분된 목록)
매개변수 이름 변경 및 쿼리로 이동. 다중 값 지원.
(body) filters.projectId (string)
(query) project_id (string)
요청 본문에서 쿼리 매개변수로 이동
응답
감사 로그 이벤트 페이로드는 REST 마이그레이션의 일부로 변경되지 않았으나, 응답 구조는 표준화된 JSON API 응답을 준수하기 위해 달라졌습니다.
V1 응답은 다음과 같이 배열 형식으로 반환됩니다.
REST 응답은 동일한 이벤트 페이로드 정보를 포함하지만 다음과 같은 형식을 가집니다.
Last updated