Cato API 호출 문제 해결

이 기사에서는 Cato 및 API 도구와 소프트웨어를 사용하여 API 쿼리를 실행할 때 발생할 수 있는 일반적인 오류에 대한 문제 해결 제안을 제공합니다． 예를 들어, Altair 및 Postman．

API 스크립트 및 코딩과 관련된 문제는 지원되지 않습니다．

필요한 API 인수

이것들은 API 쿼리에 포함해야 하는 인수입니다． API 쿼리에서 선택적 인수를 제거하면 기본값이 사용됩니다．

• accountMetrics 쿼리
  • id - 계정 ID
  • 시간 범위 - 쿼리가 반환하는 데이터의 시간 범위
  • groupDevices - 여러 사이트와 여러 소켓이 있는 사이트의 경우, 분석을 단일 소켓으로 결합 (부울 값 true에 대해)
• accountSnapshot 쿼리
  • id - 계정 ID

공통 GRAPHQL_PARSE_FAILED 오류

이 섹션에서는 Cato GraphQL 스키마와 관련된 오류 메시지의 일반적인 예를 설명합니다．

메시지: 예기치 않은 )

쿼리에 불필요한 괄호가 있습니다． 종종 이 오류는 인수에 대한 부울 값을 제공하지 않을 때 발생합니다． 예를 들어, groupInterfaces: , 대신 groupInterfaces: true,

메시지: 예상 이름, 발견된 <문자&gt；

JSON 파일이 제대로 포맷되지 않았습니다． 메시지는 누락되었거나 추가된 문자와 관련된 문자를 보여줍니다． 예를 들어, 인수 accountSnapshot((id: 42)에 대해 예상 이름, 발견됨 (． 이 인수의 올바른 형식은 accountSnapshot(id: 1941)입니다

메시지: 예상 이름, 발견된 <유효하지 않음&gt；

오류 메시지는 유효하지 않은 값이 있음을 나타냅니다．

예를 들어, Cato API에서 timeFrame 인수 (accountMetrics)는 ISO 8601 날짜 및 시간 표준에 대해 인용 부호를 사용하므로, timeFrame: "last.P1D"는 올바르고 timeFrame: last.P1D는 이 오류를 발생시킵니다．

공통 GRAPH_QL_VALIDATION_FAILED 오류

이 섹션에서는 쿼리의 인수 형식과 관련된 올바르지 않은 오류 메시지의 일반적인 예를 설명합니다．

메시지: 예상 유형 String!, 발견된 <숫자&gt；

오류 메시지는 인수에 잘못된 값이 있으며, 일반적으로 인수 형식과 관련이 있음을 나타냅니다．

예를 들어, 사이트 ids 인수 (accountMetrics > 사이트)는 STRING이므로, 값을 위해 따옴표를 사용해야 하며, ids: ["4242"]가 올바르고 ids:[4242]는 이 오류를 발생시킵니다．

메시지: 예상 유형 Int!, 발견된 \"<숫자>\"

오류 메시지는 인수에 잘못된 값이 있으며, 일반적으로 인수 형식과 관련이 있음을 나타냅니다．

예를 들어, 사이트 ids 인수 (accountSnapshot > 사이트)는 INT이므로, 값을 위해 따옴표를 사용하면 안 되며, ids: [2626]가 올바르고 ids:["2626"]는 이 오류를 발생시킵니다．

API 오류 메시지

이 섹션에서는 Cato GraphQL 스키마나 형식과 직접적으로 관련이 없는 일반적인 오류 메시지를 설명합니다．

메시지: 인증 오류

귀하의 계정에 대한 API 키에 문제가 있습니다． 제안된 솔루션：

• Cato 관리 애플리케이션 (시스템 > API 액세스 관리)에서 사용 중인 API 키가 여전히 유효한지 확인합니다． 키가 해지되면 삭제됩니다．
• API 쿼리 소프트웨어의 HTTP 헤더 설정에서 키가 올바르게 구성되었는지 확인합니다: x-api-key <키 값>
• 문제가 계속되면 새로운 API 키를 생성하고 이를 API 쿼리 소프트웨어에 추가하세요

메시지: 여러 사이트가 선택된 경우 장치를 분리할 수 없습니다 (groupDevices = false)

groupDevices 인자(accountMetrics)의 값은 쿼리에 여러 사이트가 포함될 경우 true여야 합니다．

유지보수 기간에 스크립트를 실행할 때 일반 API 오류

유지보수 기간 동안(일반적으로 매 격주 일요일) Cato는 API 서버를 업그레이드하며, 최대 2분 동안 일시적으로 사용 불가능할 수 있습니다． 재귀 API 스크립트를 실행하는 경우 유지보수 기간 동안 스크립트가 실패하고 오류를 반환할 수 있습니다． 계정 데이터에는 아무런 영향이 없습니다．

예정된 유지보수 기간 및 Cato Cloud 상태에 대한 최신 정보는 https://status.catonetworks.com/를 참조하십시오．

API 서버와의 시간 초과에 대한 일반 API 오류

API 쿼리에 40초 이상의 지연이 있는 경우 API 서버와의 시간 초과가 발생하며 쿼리를 다시 실행해야 합니다． Cato 계정의 API 스크립트에 재시도 메커니즘을 포함할 것을 권장합니다． 이 메커니즘은 최소한 두 번의 재시도 시도를 포함해야 하며 각 재시도 시도 사이에 최소 30초를 기다려야 합니다．