Cato API를 사용하기 전에, Cato API 지원 정책을 검토하시길 강력히 권장합니다．

accountMetrics 개요

accountMetrics 쿼리는 사이트와 SDP 사용자의 Cato Cloud 연결 상태 및 품질을 분석하는 데 도움이 됩니다． 이 데이터는 사이트와 Cato Cloud 사이의 DTLS 터널 내 트래픽을 위한 것입니다．

accountMetrics는 계정의 이력 메트릭스 대시보드, 통계 및 분석을 보여줍니다． Cato 관리 애플리케이션의 사이트 연결성 창과 유사한 데이터를 반환합니다．

리셀러 계정의 경우, Cato API에 연결하는 각 고객 계정 내에 별도의 API 키를 생성할 수 있습니다． rate limiting 및 accountMetrics API 쿼리에 대한 자세한 내용은 Cato API Rate Limiting 이해하기를 참조하십시오．

버킷 세분화 및 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 > 시계열을 참조하십시오．

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

이 섹션은 쿼리의 시간 내역에 따라 최소 세분화(버킷 크기)를 계산하는 방법을 설명합니다．

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 - 종료 시간
• granularity - 버킷 크기
• 사이트 - 각 사이트에 대해 반환되는 데이터 (네스티드 쿼리 및 필드 포함 배열)
• 시계열 - 데이터에 대한 시간 범위이며, 버킷과 데이터 사이의 관계를 정의합니다 (네스티드 쿼리 및 필드 포함 배열)

accountMetrics ID

ID 필드는 고유한 계정 내부 ID를 보여줍니다．

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

accountMetrics From

From 필드는 쿼리 데이터의 시작 시간을 표시하며, 시간 범위 인수에서 정의됩니다．

accountMetrics To

To 필드는 쿼리 데이터의 종료 시간을 표시하며, 시간 범위 인수에서 정의됩니다．

accountMetrics Granularity

Granularity 필드는 단일 메트릭 버킷의 지속 시간을 초 단위로 표시합니다． 버킷 수는 시간 시리즈 및 버킷 인수에 정의됩니다．

Granularity는 다음 공식을 따라 계산됩니다： 시간 범위/버킷． 예를 들어, 쿼리가 5분의 데이터(시간 범위)와 60개의 버킷을 반환하는 경우, Granularity(버킷 크기)는 5초(300초 / 60)입니다．

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

Granularity 필드에 대한 자세한 내용은 accountMetrics 및 Granularity와 함께 작업하기를 참조하세요．

accountMetrics Sites

Sites 필드는 계정에서 하나 이상의 사이트와 관련된 데이터를 포함합니다． 또한 사용자 ID로 VPN 사용자에 대한 데이터를 지정할 수 있습니다．

accountMetrics에 대한 Sites 필드에 대한 자세한 내용은 Cato API - AccountMetrics 및 Sites를 참조하세요．

accountMetrics Timeseries

쿼리에서 지정한 시간 범위(버킷)에 따라 계정의 메트릭을 보여주며, 역사적인 통계와 메트릭스를 포함합니다． 이 데이터는 각 사이트에 대한 Cato 관리 애플리케이션의 사이트 연결성 창의 필드와 유사합니다．

accountMetrics에 대한 시간 시리즈 필드에 대한 자세한 내용은 Cato API - AccountMetrics 및 Timeseries를 참조하세요．

accountMetrics에 대한 인수들

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

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

accountMetrics accountID 인수

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

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

accountMetrics 시간 범위 인수

쿼리가 반환하는 데이터의 시간 범위를 입력하세요． 인수는 <유형>.<시간 값> 형식입니다． 이 인수는 필수입니다．

다음은 시간 범위를 정의하는 지원 옵션입니다：

• last.<시간 지속 시간> - last 유형의 <시간 지속 시간> 값은 ISO-8601에 따라 특정 이전 시간의 데이터를 반환합니다． 예를 들어：
  • timeFrame = last.PT5M은 지난 5분을 보여줍니다.
  • timeFrame = last.PT2H은 지난 2시간을 보여줍니다.
  • timeFrame = last.P1D은 지난 1일을 보여줍니다.
  • timeFrame = last.P3M은 지난 3개월을 보여줍니다.
  • timeFrame = last.P1Y은 지난 1년을 보여줍니다.
• utc.<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:00부터 2020년 2월 21일 오전 4:50:00까지 10일의 분석 데이터가 표시됩니다
  • timeFrame = utc.2020-02-11/{04:50:15--16:50:15}은 2020년 2월 11일 오전 4:50:15부터 오후 4:50:15까지 12시간의 분석 데이터가 표시됩니다
  • timeFrame = utc.2020-{02-11/04:50:00--04-11/04:50:00}는 2020년 2월 11일 오전 4:50:00부터 4월 11일 오전 4:50:00까지 2개월의 분석 데이터가 표시됩니다
  • timeFrame = utc.{2019-10-01/04:50:00--2020-02-01/04:50:00}는 2019년 10월 1일 오전 4:50:00부터 2020년 2월 1일 오전 4:50:00까지 4개월의 분석 데이터가 표시됩니다

    이 형식을 사용하면 여러 달력을 포함하는 시간 범위를 구성할 수 있습니다

timeFrame 인수와 Granularity 필드에 대한 더 많은 정보는 accountMetrics > Granularity 작업을 참조하세요．

accountMetrics groupInterfaces 인수

boolean 인수 groupInterfaces가 true로 설정될 때, 모든 인터페이스의 데이터는 단일 인터페이스로 집계됩니다．

accountMetrics groupDevices 인수

boolean 인수 groupDevices가 true로 설정될 때, 모든 소켓(일반적으로 높은 가용성에서는 두 개)의 분석은 하나의 결과로 집계됩니다． 소켓 집계 결과를 최적화하려면 두 소켓에 있는 링크에 대해 일관된 이름과 기능(예: 목적지)을 사용하는 것이 좋습니다．