REST API 이해
REST API는 REST(Representational State Transfer) 인터페이스로, 주니퍼 네트웍스 Junos 운영체제(Junos OS) 디바이스에 안전하게 연결하고, 원격 프로시저 호출(rpc 명령)을 실행하고, REST API를 편리하게 실험할 수 있는 REST API Explorer GUI를 사용하고, 다양한 서식 및 표시 옵션을 사용할 수 있습니다. JSON(JavaScript Object Notation) 포함.
REST API는 계층 수준에서 제공되는 명령을 사용하여 Junos OS 디바이스에서 [edit system services rest] 구성할 수 있습니다. 구성이 완료되면 REST API를 rest 서비스로 사용할 수 있게 되며, 원격 위치에서 디바이스로 명령을 제출 rpc 할 수 있고 GET 및 POST 요청을 지원하는 REST 기반 인터페이스입니다. REST API를 사용하여 다음을 수행할 수 있습니다.
-
GET 요청을 사용하여 명령을 제출합니다
rpc. -
POST 요청을 사용하여 명령을 통해
rpc정보를 제출합니다. -
XML, ASCII(일반 텍스트) 또는 JSON으로 구성 정보를 검색합니다.
-
XML, ASCII 또는 JSON으로 운영 데이터를 검색합니다.
계층 수준에서는 [edit system services rest] Junos OS 디바이스에서 REST API 서비스를 구성 및 보호하고, IP 주소, 포트 번호, 서버 인증서, 제어 매개 변수 및 추적 옵션을 설정하고, 편리한 GUI를 사용하여 REST API를 사용해 볼 수 있는 REST API 탐색기 도구를 활성화할 수 있습니다.
다음과 같은 CLI 표시 옵션을 사용할 수 있습니다.
-
display json옵션이 | (파이프) 명령. 예를 들어 CLI 명령은show interfaces | display jsonJSON 표기법으로 인터페이스를 표시합니다. -
format="json"NETCONF 서버 명령에 JSON 표기법으로 운영 정보를 반환하는 옵션이 추가되었습니다.
REST API 수신 요청 페이로드 크기는 1174KB를 초과할 수 없습니다.
해결 방법: 들어오는 REST API 요청을 더 작은 크기로 청크합니다.
REST API는 HTTP 기본 인증을 지원하며 모든 요청에는 권한 부여 헤더에 포함된 base64로 인코딩된 사용자 이름과 암호가 필요합니다. HTTP 및 HTTPS 지원을 모두 사용할 수 있습니다.
-
보안 연결이 필요하지 않은 경우 HTTP를 사용하여 일반 텍스트를 사용하여 콘텐츠를 교환할 수 있습니다.
-
HTTPS를 사용하여 사용 가능한 암호 그룹 중 하나를 통해 암호화된 콘텐츠를 교환하는 것이 좋습니다. 클라이언트 인증 없이 서버 인증을 요구하도록 REST API를 구성하거나 상호 인증을 구성할 수 있습니다.
디바이스에서 REST API가 구성되면 GET 또는 POST 요청을 통해 단일 rpc 명령을 실행하거나 단일 POST 요청을 통해 여러 rpc 명령을 실행하는 데 새 REST 엔드포인트를 사용할 수 있습니다. 자세한 내용은 REST API에 GET 요청 제출 및 REST API에 POST 요청 제출을 참조하십시오.
Junos OS는 압축 JSON 형식의 운영 상태 데이터 내보내기를 지원합니다. JSON 데이터를 압축 형식으로 내보내려면 계층 수준에서 문을 [edit system export-format state-data] 구성합니다json compact. 그렇지 않으면 디바이스는 기본적으로 압축되지 않은 형식으로 JSON 데이터를 내보냅니다.
또한 REST API는 REST API 사용 방법을 쉽고 빠르게 학습할 수 있는 REST API Explorer라는 GUI를 제공합니다. 기본적으로 비활성화되어 있으며 를 지정 set system services rest enable-explorer하여 활성화할 수 있습니다. REST API 탐색기에 대한 자세한 내용은 예제: REST API 탐색기 사용을 참조하세요.
변경 내역 표
기능 지원은 사용 중인 플랫폼과 릴리스에 따라 결정됩니다. 기능 탐색기 를 사용하여 플랫폼에서 기능이 지원되는지 확인하세요.
[edit system export-format state-data json] 더 이상 사용되지 않습니다
compact.