Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
이 페이지 내용
 

예: REST API Explorer 사용

이 예는 REST API가 구성된 Junos OS 디바이스에서 REST API 탐색기를 선택적으로 사용하는 방법을 보여줍니다.

요구 사항

  • Junos OS 릴리스 14.2 이상을 실행하는 M Series, MX 시리즈, T 시리즈 또는 PTX 시리즈 디바이스가 필요합니다.

개요

REST API Explorer를 사용하면 단일 또는 여러 RPC 호출을 편리하게 테스트할 수 있습니다. GUI는 HTTP 메서드(GET 또는 POST), 필요한 출력 형식(XML, JSON 또는 일반 텍스트), RPC URL, POST 요청 사용 시 입력 데이터 유형(XML 또는 일반 텍스트) 및 오류 발생 시 종료 조건을 선택하는 옵션을 제공합니다.

Junos에서는 GET과 POST를 모두 사용하여 단일 운영 RPC(예: get-software-information)를 실행할 수 있습니다. 두 메서드 모두 동일한 정보를 검색할 수 있지만 여러 RPC를 실행하거나 요청 본문에 XML 데이터를 포함해야 하는 경우(-d 옵션 사용) POST가 필요합니다.

요청을 제출하면 REST API 탐색기에 요청 헤더, 응답 헤더, 응답 본문 및 이와 동등한 cURL 요청이 표시되며, 이 모든 것이 개발 노력에 유용합니다.

구성

REST API가 구성된 디바이스에서 REST API 탐색기를 사용하려면 다음 태스크를 수행하십시오.

REST API Explorer 사용

단계별 절차

REST API 탐색기를 사용하도록 설정하려면 다음을 수행합니다.

  1. 디바이스에서 REST API를 구성합니다.

    자세한 내용 및 예제 는 REST API 구성 및 예제: REST API 구성을 참조하십시오.

  2. REST API Explorer를 사용할 수 있는지 확인합니다.

    show 명령을 사용하여 REST API 구성에 나타나는지 enable-explorer; 확인합니다. 표시되는 경우 REST API Explorer가 활성화된 것입니다. 표시되지 않으면 REST API 탐색기를 사용하도록 설정해야 합니다.

  3. 필요한 경우 REST API Explorer를 사용하도록 설정합니다.

    set 명령을 사용하여 REST API 구성에 나타나는지 확인합니다enable-explorer;.

REST API Explorer 열기

단계별 절차

REST API 탐색기를 열려면 다음을 수행합니다.

  • REST API 탐색기가 사용하도록 설정되어 있는지 확인하고, 브라우저를 열고, scheme://device-name:port URL(예: https://mydevice:3000)로 이동합니다.

HTTP GET 요청을 사용하여 단일 RPC 실행

단계별 절차

HTTP GET 요청을 사용하여 단일 RPC를 실행하려면:

  1. HTTP 메서드 드롭다운 목록에서 GET을 선택합니다.

  2. RPC URL 엔드포인트를 입력합니다.

    예를 들어 을 입력합니다 /rpc/get-software-information.

  3. 사용자 이름과 비밀번호를 입력합니다.

  4. Submit(제출)을 클릭합니다.

    이 예제에서는 기본 출력 형식인 XML이 응답 본문에 반환됩니다.

HTTP POST 요청을 사용하여 단일 RPC 실행

단계별 절차

HTTP POST 요청을 사용하여 단일 RPC를 실행하려면 다음을 수행합니다.

  1. HTTP 메서드 드롭다운 목록에서 POST를 선택합니다.

  2. 필수 출력 형식 드롭다운 목록에서 JSON을 선택합니다.

  3. 이 RPC URL 끝점을 /rpc/get-software-information입력합니다.

  4. 사용자 이름과 비밀번호를 입력합니다.

  5. 요청 본문 텍스트 영역에 XML 형식의 요청을 입력합니다.

    예를 들어:

  6. Submit(제출)을 클릭합니다.

    이 예제에서는 JSON 출력 형식이 응답 본문에 반환됩니다.

  7. 다른 출력 형식을 선호하는 경우 필수 출력 형식 드롭다운 목록에서 사용 가능한 선택 항목 중 하나를 선택합니다.

    예를 들어 일반 텍스트를 선택할 수 있습니다. Submit(제출)을 클릭하면 Response Body(응답 본문)에 일반 텍스트가 표시됩니다.

    마찬가지로 필수 출력 형식 드롭다운 목록에서 XML을 선택하면 응답 본문에 XML 형식 정보가 포함됩니다.

여러 RPC 실행

단계별 절차

여러 RPC를 실행하려면:

  1. HTTP 메서드 드롭다운 목록에서 POST를 선택합니다.

    여러 RPC를 실행할 때 항상 필요합니다.

  2. 오류 발생 시 조건부 종료를 설정하려면 오류 발생 시 종료 확인란을 선택합니다.

  3. 필수 출력 형식 드롭다운 목록에서 출력 형식을 선택합니다.

    예를 들어 JSON을 선택할 수 있습니다.

  4. 이 RPC URL 끝점은 자동으로 채워집니다 /rpc?exit-on-error=1.

  5. 사용자 이름과 비밀번호를 입력합니다.

  6. 요청 본문 텍스트 영역에 XML 형식의 요청을 입력합니다.

    예를 들어:

  7. Submit(제출)을 클릭합니다.

    이 예제에서는 JSON 출력 형식이 응답 본문에 반환됩니다.

오류 메시지 보기

단계별 절차

여러 RPC를 실행하면 오류가 발생할 수 있습니다. 오류 발생 시 종료 확인란을 선택하면 오류가 발생할 경우 출력에 오류 메시지가 나타납니다.

오류 메시지 보기:

  1. HTTP 메서드 드롭다운 목록에서 POST를 선택합니다.

    여러 RPC를 실행할 때 항상 필요합니다.

  2. 오류 발생 시 조건부 종료를 설정하려면 오류 발생 시 종료 확인란을 선택합니다.

  3. 필수 출력 형식 드롭다운 목록에서 출력 형식을 선택합니다.

    예를 들어 JSON을 선택할 수 있습니다.

  4. 이 RPC URL 끝점은 자동으로 채워집니다 /rpc?exit-on-error=1.

  5. 사용자 이름과 비밀번호를 입력합니다.

  6. 요청 본문 텍스트 영역에 오류가 포함된 XML 형식의 요청을 입력합니다.

    예를 들어:

  7. Submit(제출)을 클릭합니다.

    이 예제에서는 JSON 출력 형식이 응답 본문에 반환되며, 응답 본문 끝에 XML 형식의 오류 메시지가 표시됩니다.

  8. 오류 발생 시 종료 확인란을 선택하지 않으면 오류가 발생할 경우 응답 본문에 오류 메시지가 나타납니다.

    오류가 처리된 후에도 실행이 계속되고 결과도 응답 본문에 포함됩니다.

관련 설명서