Cato API를 사용하기 전에 Cato API 지원 정책을 검토할 것을 강력히 권장합니다.

accountMetrics 개요

accountMetrics 쿼리는 사이트와 VPN 사용자들의 Cato Cloud로의 연결 상태와 품질을 분석하는 데 도움이 됩니다. 이 데이터는 사이트와 Cato Cloud 사이의 DTLS 터널 내부의 트래픽에 관한 것입니다.

accountMetrics는 계정을 위한 역사적 메트릭, 통계 및 분석 정보를 보여줍니다. Cato 관리 애플리케이션의 사이트 연결 창과 유사한 데이터를 반환합니다.

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

버킷 세분성과 API 쿼리 제한 다루기

accountMetrics API 쿼리당 반환되는 최대 항목 수는 100,000개입니다. 쿼리가 이 한도에 도달하면 추가 데이터를 반환하지 않고 오류 메시지가 표시됩니다.

Cato는 다음 요소들의 곱셈을 기반으로 이 한도를 계산합니다:

• 사이트와 VPN 사용자의 총 수
• 메트릭 수 (API 라벨/텔레메트리)
• 버킷 수

다시 말해, (사이트 + VPN 사용자) * (메트릭) * (버킷)의 합은 100,000 미만이어야 합니다. 예를 들어, 다음 쿼리는 오류를 발생시킵니다:

• 10개의 사이트
• 140명의 VPN 사용자
• 5개의 메트릭
• 150개의 버킷

(10 + 140) * 5 * 150 = 112,500개의 항목이 쿼리에 포함되어 있습니다. 이 예시에서는 쿼리를 성공적으로 실행하기 위해 버킷 수를 줄일 수 있습니다.

API 라벨 유형에 대해 더 알아보려면, Cato API - AccountMetrics > Timeseries를 참조하세요.

쿼리를 위한 최소 세분성 계산

이 섹션은 쿼리의 시간 프레임을 기반으로 최소 세분성(버킷 크기)을 계산하는 방법을 설명합니다.

1. 시간 프레임 - 시간 프레임을 초로 변환
2. 버킷 제한 - 100000 / ((사이트 + VPN 사용자) * (메트릭)) 에 기반하여 버킷 제한 계산
3. 최소 세분성 = (시간 프레임) / (버킷 제한)

예를 들어, 아래 표의 첫 번째 행은 7일 동안 100개의 사이트 및 VPN 사용자, 5개의 메트릭에 대한 쿼리 제한을 보여줍니다.

• 7일 = 604,800초
• 200개의 버킷 = 10000 / (100) * (5)
• 3024초 최소 세분성 = 604800 / 200

다음 표는 최소 버킷 세분성을 가진 accountMetrics 쿼리에 대한 샘플 설정을 보여줍니다.

accountMetrics 필드에 대한 세부 정보

다음은 accountMetrics 필드가 쿼리에 대해 반환할 수 있는 세부 정보입니다:

• ID - 계정 ID
• from - 시작 시간
• to - 종료 시간
• 세분성 - 버킷 크기
• 사이트 - 각 사이트에 대해 반환되는 데이터 (중첩된 쿼리 및 필드가 있는 배열)
• timeseries - 데이터의 시간 프레임을 나타내고, 버킷과 데이터 간의 관계를 정의합니다 (중첩된 쿼리 및 필드가 있는 배열)

accountMetrics ID

ID 필드는 고유 계정 내부 ID를 나타냅니다.

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

accountMetrics From

From 필드는 쿼리 데이터의 시작 시간을 나타내며, 시간 프레임 인수에서 정의됩니다.

accountMetrics To

To 필드는 쿼리 데이터의 종료 시간을 나타내며, 시간 프레임 인수에서 정의됩니다.

accountMetrics 세분성

세분성 필드는 메트릭 버킷의 각 지속 시간을 초 단위로 표시합니다. 버킷의 수는 timeseries > bucket 인수에서 정의됩니다.

세분성은 다음 공식에 따라 계산됩니다: 시간 프레임/버킷. 예를 들어, 쿼리가 5분 간의 데이터(timeFrame)를 60개의 버킷과 함께 반환하는 경우, 세분성(버킷 크기)은 5초입니다 (300초 / 60).

버킷의 최소 세분성은 5초입니다. 버킷의 세분성이 5초 미만인 경우, 해당 버킷에 대한 데이터가 반환되지 않을 수 있습니다.

세분성 필드에 대한 더 자세한 내용은 accountMetrics > 세분성 다루기를 참조하세요.

accountMetrics 사이트

사이트 필드는 계정 내 사이트 하나 이상과 관련된 데이터를 포함합니다. 사용자 ID와 함께 VPN 사용자에 대한 데이터를 지정할 수도 있습니다.

accountMetrics의 사이트 필드에 대한 자세한 내용은 Cato API - AccountMetrics > 사이트를 참조하세요.

accountMetrics 시계열

쿼리에서 지정된 시간 프레임(버킷)에 따라 계정의 메트릭을 표시하며, 역사적 통계와 메트릭을 포함합니다. 이 데이터는 Cato 관리 애플리케이션의 각 사이트에 대한 사이트 연결 창과 유사합니다.

accountMetrics의 시계열 필드에 대한 자세한 내용은 Cato API - AccountMetrics > 시계열을 참조하세요.

accountMetrics 인수

다음은 쿼리가 반환할 데이터를 전달하고 정의할 수 있는 인수입니다:

• accountID - 계정 ID
• ID - 계정 ID (레거시 인수)
• timeFrame - 쿼리의 시작 및 종료 시간
• groupInterfaces - 모든 링크에 대한 분석을 단일 링크로 결합 (boolean 값 true인 경우)
• groupDevices - 여러 사이트와 단일 사이트에 여러 소켓이 있는 경우 분석을 단일 소켓으로 결합 (boolean 값 true인 경우)

accountMetrics accountID 인수

쿼리가 반환하는 데이터의 계정 ID를 입력하세요. 이 인수는 필수입니다.

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

accountMetrics timeFrame 인수

쿼리가 반환하는 데이터의 시간 프레임을 입력하세요. 인수는 형식 <유형>.<시간 값>. 이 인수는 필수입니다.

다음은 시간 프레임을 정의하는 데 지원되는 옵션입니다:

• 지난.<시간 기간> - last 유형의 <time duration> 값은 ISO-8601에 따라 이전 특정 시간에 대한 데이터를 반환합니다. 예를 들어:
  • timeFrame = last.PT5M는 이전 5분을 보여줍니다.
  • timeFrame = last.PT2H는 이전 2시간을 보여줍니다.
  • timeFrame = last.P1D는 이전 1일을 보여줍니다.
  • timeFrame = last.P3M는 이전 3개월을 보여줍니다.
  • timeFrame = last.P1Y는 이전 1년을 보여줍니다.
• utc.<짧은 시간 프레임 사양> - 시간 프레임은 지정된 시간대에 따라 YY-MM-DD/hh:mm:ss 형식의 시작 및 종료 날짜를 결합합니다. 인수에 대한 모든 날짜와 시간 값을 입력해야 합니다. 예를 들어:
  • timeFrame = utc.2020-02-{11/04:50:00--21/04:50:00}은 2020년 2월 11일 오전 4시 50분 0초부터 2월 21일 오전 4시 50분 0초까지 10일간의 분석 데이터를 보여줍니다.
  • timeFrame = utc.2020-02-11/{04:50:15--16:50:15}은 2020년 2월 11일에 오전 4시 50분 15초부터 오후 16시 50분 15초까지 12시간의 분석 데이터를 보여줍니다.
  • timeFrame = utc.2020-{02-11/04:50:00--04-11/04:50:00}은 2020년 2월 11일 오전 4시 50분 0초부터 4월 11일 오전 4시 50분 0초까지 2개월의 분석 데이터를 보여줍니다.
  • timeFrame = utc.{2019-10-01/04:50:00--2020-02-01/04:50:00}는 2019년 10월 1일 오전 4시 50분 0초부터 2020년 2월 11일 오전 4시 50분 0초까지 4개월의 분석 데이터를 보여줍니다.

    이 형식을 통해 여러 회계 연도가 포함된 시간 프레임을 구성할 수 있습니다.

timeFrame 인수와 세분성 필드에 대한 더 자세한 내용은 accountMetrics > 세분성 다루기를 참조하세요.

accountMetrics groupInterfaces 인수

boolean 인수 groupInterfaces가 true로 설정되면, 모든 인터페이스의 데이터가 하나의 인터페이스로 집계됩니다.

accountMetrics groupDevices 인수

boolean 인수 groupDevices가 true로 설정되면, 모든 소켓(대개 고가용성에서는 두 개)의 분석이 하나의 결과로 집계됩니다. 집계된 소켓에 대한 최상의 결과를 위해, 두 소켓 모두의 링크에 대해 일관된 이름과 기능(예: 대상)을 사용하는 것이 좋습니다.