Cato API 호출 문제 해결

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

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

필수 API 인자

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

accountMetrics 쿼리
- id - 계정 ID
- timeframe - 쿼리가 반환하는 데이터의 시간 범위
- groupDevices - 여러 사이트와 여러 소켓을 갖춘 사이트의 경우 분석을 단일 소켓으로 결합합니다(참 부울 값 true)
accountSnapshot 쿼리
- id - 계정 ID

일반적인 GRAPHQL_PARSE_FAILED 오류

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

메시지: 예상치 못한 )

쿼리에 추가 괄호가 있습니다. 일반적으로 이 오류는 인자에 대한 부울 값을 제공하지 않을 때 발생합니다. 예를 들어, groupInterfaces: , 대신 groupInterfaces: true,

메시지: 예상된 이름, 발견됨 <문자>

JSON 파일이 올바르게 형식화되지 않았습니다. 메시지는 누락되거나 추가된 문자와 관련된 문자를 표시합니다. 예를 들어, 인자 accountSnapshot((id: 42)에 대해 예상된 이름, 발견됨 (. 이 인자에 대한 올바른 형식은 accountSnapshot(id: 1941)입니다.

메시지: 예상된 이름, 발견됨 <유효하지 않음>

오류 메시지는 잘못된 값을 가진 인자가 있음을 나타냅니다.

예를 들어, Cato API의 accountMetrics 인자(timeFrame)는 ISO 8601 날짜 및 시간 표준에 대해 따옴표를 사용합니다, timeFrame: "last.P1D"는 올바르며 timeFrame: last.P1D는 이 오류를 발생시킵니다.

일반 GRAPH_QL_VALIDATION_FAILED 오류

이 섹션에서는 쿼리의 인자 형식이 잘못된 경우에 관련된 오류 메시지의 일반적인 예를 설명합니다.

메시지: 예상된 유형 문자열!, 발견됨 <숫자>

오류 메시지는 인자 형식과 관련하여 잘못된 값을 가진 인자가 있음을 나타냅니다.

예를 들어, accountMetrics > sites의 인자(sites ids)는 문자열이므로, 값에 대한 따옴표를 사용해야 합니다, ids: ["4242"]는 올바르며 ids:[4242]는 이 오류를 발생시킵니다.

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

오류 메시지는 인자 형식과 관련하여 잘못된 값을 가진 인자가 있음을 나타냅니다.

예를 들어, accountSnapshot > sites의 인자(sites ids)는 INT이므로 값에 대한 따옴표를 사용하면 안 됩니다, ids: [2626]는 올바르며 ids:["2626"]는 이 오류를 발생시킵니다.

API 오류 메시지

이 섹션은 Cato GraphQL 스키마 또는 형식과 구체적으로 관련되지 않은 일반적인 오류 메시지를 설명합니다.

메시지: 인증 오류 또는 403

계정의 API 키에 문제가 있습니다. 제안된 해결 방법:

Cato 관리 애플리케이션(시스템 > API 액세스 관리)에서 다음을 확인하십시오:
- 사용 중인 API 키가 여전히 유효한지(존재하며 만료되지 않았는지)
- IP에서 액세스 허용 옵션이 설정되어 있는 경우, API 클라이언트가 호출을 허용된 특정 IP 주소나 범위에서 수행하고 있는지
HTTP 헤더 설정에서 API 쿼리 소프트웨어에 키가 올바르게 구성되었는지 확인: x-api-key: <키 값>, 예를 들어 x-api-key: abcdef12345
문제가 계속되면 새 API 키를 생성하여 API 쿼리 소프트웨어에 추가하십시오

다음은 API 클라이언트에 대한 유효한 HTTP 헤더의 예입니다:

POST /api/v1/graphql2 HTTP/2
Host: api.catonetworks.com
User-Agent: curl/8.7.1
Accept: */*
Content-Type:application/json
x-api-key: abcdef123456789

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

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

API 분석 데이터 변환

Cato API는 트래픽 데이터를 바이트 단위로 반환합니다. 데이터를 더 큰 단위(MB 또는 GB와 같은)로 변환하려면 1024의 지수 값으로 나누어야 합니다: MB는 1024², GB는 1024³.

예를 들어, 536,870,912,000 바이트를 GB로 변환하려면 1024³으로 나눠 500GB의 데이터를 나타냅니다.