이 문서는 계정에서 설정 및 항목을 모니터링하고 구성하기 위해 카토 API를 사용하는 방법에 대한 안내를 제공합니다.
카토 API는 카토 클라우드와의 원활한 통합을 위한 주요 자동화 인터페이스입니다. 카토 API를 사용하여 배포 및 구성과 같은 효율적인 운영 워크플로를 설정하고 네트워크 및 보안 관리를 간소화하기 위한 포괄적 상태 모니터링, 통계 및 데이터 수집 및 분석을 수행하십시오.
API 엔드포인트 및 스키마의 URL은 카토 관리 애플리케이션(CMA) 인스턴스가 호스팅되는 위치에 따라 다릅니다. CMA 계정의 URL과 API 엔드포인트 및 스키마에 추가되는
API 엔드포인트의 URL 형식은 https://api.<prefix>.catonetworks.com/api/v1/graphql2.
API 스키마의 URL 형식은 https://api.<prefix>.catonetworks.com/api/schema.
API 엔드포인트의 URL
-
접두사(
cc.catonetworks.com)가 없으면 다음 URL을 사용하십시오:https://api.catonetworks.com/api/v1/graphql2 -
접두사(예:
cc.us1.catonetworks.com)가 있는 경우 다음 URL을 사용하십시오(다른 위치에 대해 접두사를 수정):https://api.us1.catonetworks.com/api/v1/graphql2
API 스키마의 URL
-
접두사(
cc.catonetworks.com)가 없으면 다음 URL을 사용하십시오:https://api.catonetworks.com/api/schema -
접두사(예:
cc.us1.catonetworks.com)가 있는 경우 다음 URL을 사용하십시오(다른 위치에 대해 접두사를 수정):https://api.us1.catonetworks.com/api/schema
카토 API는 GraphQL 기반으로 구축되어 있으며, RESTful API 도구 및 클라이언트와 완전히 호환되는 직관적인 인터페이스를 제공합니다. GraphQL은 필요로 하는 데이터만 정확하게 쿼리할 수 있는 가변성을 제공하여 과도한 데이터 수집을 줄이고 효율성을 향상시킵니다.
카토 API 문서는 카토 네트웍스 GraphQL API 참조에서 이용할 수 있으며, 다음 내용을 포함합니다:
-
스키마 정의 및 문서
-
예제 API 호출과 이에 따른 샘플 응답
-
API 탐색 및 테스트를 위한 인터랙티브 플레이그라운드를 갖춘 GraphQL API 엔드포인트
이 섹션은 특정 API의 성숙도 수준과 가용성에 따라 다른 라이프사이클 단계를 설명합니다.
모든 새로운 API는 처음에 베타 단계에서 출시됩니다. 베타에서 GA로의 전환은 API가 안정적이고 생산 준비가 되었는지를 확인하기 위한 내부 검토 및 고려를 거칩니다. 일반적으로 베타에서 GA로의 전환에는 약 1년이 걸립니다.
참고
참고: 아래에서 설명하는 라이프사이클은 카토 네트웍스 GraphQL API 참조에 정의된 공식 카토 API에만 해당됩니다. 제공될 수 있는 추가 도구 및 예시는 포함되지 않습니다.
예를 들어, 오픈 소스 예제 및 유틸리티는 카토 GitHub 계정에서 이용할 수 있습니다. 이러한 리소스는 추가 개발, 유지 관리 또는 지원에 대한 보증 없이 "있는 그대로" 제공됩니다.
다음은 라이프사이클 단계의 일부로 API 성숙도 수준입니다.
-
베타: 베타 단계의 API는 기능이 완비되어 운영이 완전하며, 생산 환경에서 사용하기에 적합합니다. 그러나 사용자 피드백 또는 추가 고려 사항에 따라 변경될 수 있습니다. API 스키마에 대한 붕괴 가능성을 포함하여 이러한 변경 사항은 짧은 공지로 발생할 수 있으며 클라이언트 코드 업데이트가 필요합니다.
-
GA(일반 공급): GA의 API는 안정적이고 생산 준비가 되었으며, 장기 지원과 후방 호환에 대한 약속을 제공합니다. API 스키마에 대한 붕괴형 변경은 드물며 클라이언트 코드 조정을 위한 충분한 시간을 제공하고 사전에 잘 통보됩니다.
베타로 명시되지 않은 API는 GA로 간주됩니다. 어떤 경우에는 GA API 내에서 개별 필드, 유형 및 입력이 베타로 표시될 수 있습니다.
다음은 라이프사이클 단계의 일환으로 API의 가용성 수준입니다.
-
EA(얼리 어베일러빌리티): EA의 API는 보다 넓은 출시 전에 테스트 및 피드백을 위한 제한된 사용자 그룹에 제공됩니다. 접근은 특별한 승인 또는 조건이 필요할 수 있습니다.
-
점진적 배포: 클라우드 기반 서비스에 대한 표준 산업 최선 사례를 따르며, 카토 API는 점진적으로 배포되어 안정성을 보장하고 성능을 모니터링하며 시간이 지남에 따라 모든 계정으로 가용성을 확장합니다.
EA나 점진적 배포로 표시되지 않은 API는 모든 사용자에게 완전히 배포되고 접근 가능한 것으로 간주됩니다.
이 섹션은 성숙도 및 가용성 수준별로 문서에 사용되는 API 레이블을 요약합니다.
레이블이 없는 API는 모든 계정에 완전히 제공되며 스키마 변경이 드물게 발생합니다. 이러한 변경 사항은 몇 개월 전에 사전에 발표됩니다. 이러한 변경에 대한 자세한 내용은 아래의 잠재적인 스키마 붕괴 변경을 참조하십시오.
-
EA
-
카토의 EA 프로그램에 가입한 고객에게만 제공되며, 가입하려면 ea@catonetworks.com으로 문의하십시오.
-
-
베타
-
스키마에 변화가 있을 수 있습니다.
-
짧게는 2주 정도의 기간 동안의 공지로 붕괴 가능성이 있는 변경 사항이 있을 수 있습니다.
-
베타 API는 전체 기능을 지원합니다.
-
-
배포
-
이 GA API는 몇 주에 걸쳐 모든 계정에 점진적으로 배포되고 있습니다.
-
배포 상태의 API 호출은 해당 API가 아직 계정에서 사용할 수 없기 때문에 오류 메시지를 초래할 수 있습니다.
-
이 섹션은 API 호출 협상에 영향을 미칠 수 있는 GraphQL API 스키마의 변경 사항이 있을 때에 대해 논의합니다.
GraphQL에서의 잠재적인 붕괴 변경은 클라이언트 애플리케이션이 기능을 유지하기 위해 쿼리나 로직을 업데이트해야 하는 API 변경을 가리킵니다. 예시:
-
필드, 유형, 또는 인수 제거.
-
필드, 유형, 인수 이름 변경.
-
쿼리 또는 변이의 예상 결과를 변경하는 방식으로 인수의 기본값 수정.
-
호환성에 영향을 미치는 방식으로 필드 유형이나 동작 변경. 예를 들어, 필드의 유형 변경(예: Int에서 String으로) 또는 인수의 nullability 변경(예: nullable에서 non-nullable로).
우리는 잠재적인 스키마 붕괴 변경을 최대한 피하기 위해 노력합니다. 그러나 드물게 그러한 변경이 있을 경우, EoL API 공지 아래 설명된 대로 고객에게 통보됩니다.
이러한 변경은 베타 API에서는 더 자주 발생할 수 있지만 GA API에서는 드뭅니다.
사용 중단으로 표시된 API 또는 필드는 더 나은 대안이 있음을 나타내며, 사용을 권장하지 않습니다. 예상 가능한 동작과 기능을 유지하기 위해 사용 중단된 API 및 필드를 더 이상 사용하지 않도록 스크립트와 프로세스를 업데이트하는 것이 좋습니다.
API나 필드가 제거되거나 교체될 계획이 있는 경우, 종료 프로세스를 거치게 됩니다. 이 프로세스에는 다음 단계가 포함됩니다.
-
API 또는 필드를 사용 중단으로 표시
-
제거가 계획된 API 또는 필드는 사용 중단으로 카토 네트웍스 GraphQL API 참조에 표시됩니다.
-
이 레이블은 가능한 경우 대안 API 또는 필드를 명시하는 메시지와 계획된 종료 날짜와 함께 제공됩니다.
-
-
EoL 공지
-
카토 API 잠재적인 스키마 붕괴 변경 및 EoL 기사는 스키마가 변경될 특정 날짜로 업데이트됩니다.
-
알림과 스키마 변경 사이의 기간은 다음과 같습니다.
-
GA API: 최소 3개월 전에, 일반적으로 6개월 전에
-
베타 API: 일반적으로 2주 전에
-
-
EoL 공지와 EoL 날짜 사이의 기간 동안 고객은 GraphQL 스키마 변경 사항에 맞게 클라이언트 코드를 업데이트해야 합니다.
-
중단되지 않고도 여전히 중요한 GraphQL 변경, 예를 들어 새 API 또는 새 필드는 카토 API 변경 로그 기사에 발표됩니다.
카토 네트웍스 GraphQL API 참조는 항상 지원되어 최신의 GraphQL 스키마를 완전하게 포함하고 있습니다.
댓글 0개
댓글을 남기려면 로그인하세요.