REST API 이해
REST API는 REST(Representational State Transfer) 인터페이스로, 안전하게 주니퍼 네트웍스 Junos 운영체제(Junos OS) 디바이스에 연결하고, 원격 절차 호출(명령)을 실행하며, REST API Explorer GUI를 사용하여 REST API를 편리하게 테스트하고 rpc JSON(JavaScript Object Notation)을 비롯한 다양한 포맷 및 디스플레이 옵션을 사용할 수 있습니다.
REST API는 계층 Junos OS 사용 가능한 명령을 사용하여 디바이스에서 [edit system services rest] 구성할 수 있습니다. 일단 구성되면 REST API가 서비스로 제공되면 원격지에서 장비에 명령을 전송하고 GET 및 POST 요청을 지원할 수 있는 REST 기반 인터페이스가 rest rpc 제공됩니다. REST API를 사용하면 다음을 할 수 있습니다.
GET 요청을 사용하여
rpc명령을 전송합니다.POST 요청을 사용하여 명령을 통해 정보를
rpc제출합니다.XML, ASCII(일반 텍스트) 또는 JSON에서 구성 정보를 검색합니다.
XML, ASCII 또는 JSON에서 운영 데이터를 검색합니다.
계층 수준에서는 장비에서 REST API 서비스를 구성하고 Junos OS, IP 주소, 포트 번호, 서버 인증서, 제어 매개변수 및 추적 옵션을 설정하고, 편리한 GUI를 사용하여 REST API를 사용해 볼 수 있는 REST API 탐색기 도구를 사용할 수 [edit system services rest] 있습니다.
다음과 같은 CLI 디스플레이 옵션을 사용할 수 있습니다.
옵션이
display json이 옵션에 | (파이프) 명령. 예를 들어, CLIshow interfaces | display json명령어는 JSON의 지정 인터페이스에 표시되어 있습니다.JSON의 notation으로 운영 정보를 반환하기 위해 NETCONF 서버 명령에
format="json"옵션이 추가됩니다.
OpenConfig는 Junos OS Release 17.3R1 릴리스에서부터 XML 형식과 함께 데몬이 직접 JSON 형식으로 내보이는 운영 상태를 지원할 수 있습니다. JSON 컴팩트 형식을 구성하기 위해 다음 CLI set system export-format state-data json compact 명령어를 지정합니다. 이 CLI XML 형식을 컴팩트한 JSON 형식으로 변환합니다. JSON을 비콤팩트(non-compact) 형식으로 내보 내보는 기능도 있습니다.
REST API 수신 요청 페이로드 크기는 1174KB를 초과할 수 없습니다.
해결 사항: 수신 REST API 요청을 작은 크기로 청크합니다.
REST API는 HTTP Basic Authentication을 지원하며 모든 요청에는 인증 헤더에 포함된 기본64 인코딩 사용자 이름과 암호가 필요합니다. HTTP 및 HTTPS 지원은 모두 사용할 수 있습니다.
보안 연결이 필요 없는 경우 HTTP를 사용하여 명확한 텍스트로 컨텐츠를 교환할 수 있습니다.
HTTPS를 사용하여 사용 가능한 암호 제품군 중 하나를 사용하여 암호화된 컨텐트의 교환을 권장합니다. 클라이언트 인증 없이 서버 인증을 요구하도록 REST API를 구성하거나 상호 인증을 구성할 수 있습니다.
장비에서 REST API가 구성되면 GET 또는 POST 요청을 통해 단일 명령을 실행하거나 단일 POST 요청을 통해 여러 명령을 실행하는 새로운 REST 단말 장치를 사용할 수 rpc rpc 있습니다. 자세한 정보는 REST API에 GET Request를 제출하고 POST Request를 REST API에 제출하십시오.
또한 REST API는 REST API Explorer라는 GUI를 제공합니다. 이를 통해 REST API의 사용 방법을 쉽고 빠르게 배울 수 있습니다. 기본적으로 비활성화되어 있으며, 를 지정하여 활성화할 수 set system services rest enable-explorer 있습니다. REST API Explorer에 대한 자세한 내용은 예: REST API Explorer 사용 을 참조합니다.