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가 구성된 디바이스에서 선택적으로 REST API Junos OS 사용하는 방법을 시연합니다.

요구 사항

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

개요

REST API Explorer를 사용하면 단일 또는 여러 RPC 호출을 편리하게 테스트할 수 있습니다. GUI는 HTTP 메소드(GET 또는 POST), 필수 출력 형식(XML, JSON 또는 일반 텍스트), RPC URL, POST 요청(XML 또는 일반 텍스트)을 사용할 때 입력 데이터 유형, exit-on-error 조건을 선택할 수 있는 옵션을 제공합니다. 요청을 제출할 때 REST API Explorer는 요청 헤더, 응답 헤더, 응답 본문 및 동등한 cURL 요청 모두 개발에 유용합니다.

구성

REST API가 구성된 모든 디바이스에서 REST API Explorer를 사용하려면 다음 작업을 수행합니다.

REST API Explorer 활성화

단계별 절차

REST API Explorer를 사용하려면 다음을 제공합니다.

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

    REST API 구성 및 예: 정보 및 예제를 위해 REST API 구성을 참조하십시오.

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

    명령어를 사용하여 show enable-explorer; REST API 구성에 나타나는지 확인 나타나는 경우 REST API Explorer가 활성화되었습니다. 나타나지 않는 경우 REST API Explorer를 활성화해야 합니다.

  3. 필요한 경우 REST API Explorer를 활성화합니다.

    set명령어를 사용하여 enable-explorer; REST API 구성에 표시되도록 합니다.

REST API Explorer 열기

단계별 절차

REST API Explorer를 열기:

  • REST API Explorer를 활성화하고 브라우저를 열고 다음 URL로 이동하십시오. scheme://device-name:port(예: https://mydevice:3000).

HTTP GET Request를 사용하여 단일 RPC 실행

단계별 절차

HTTP GET Request를 사용하여 단일 RPC를 실행하기 위해 다음을 제공합니다.

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

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

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

  3. 사용자 이름과 암호를 입력합니다.

  4. Submit 을 클릭합니다.

    이 예에서는 기본 출력 형식인 XML이 Response Body에 반환됩니다.

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

단계별 절차

HTTP POST Request를 사용하여 단일 RPC를 실행하기 위해 다음을 제공합니다.

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

  2. Required output format drop-down list에서 JSON을 선택합니다.

  3. 이 RPC URL 엔드포인트를 /rpc/get-software-information 입력합니다.

  4. 사용자 이름과 암호를 입력합니다.

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

    예를 들어:

  6. Submit 을 클릭합니다.

    다음 예제에서 JSON 출력 형식은 Response Body에 반환됩니다.

  7. 다른 출력 형식을 원할 경우 필요한 출력 형식 드롭다운 목록에서 사용 가능한 옵션 중 하나를 선택합니다.

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

    마찬가지로, Required output format 드롭다운 목록에서 XML을 선택하면 응답 본문에 XML 형식의 정보가 포함되어 있습니다.

여러 개의RPC 실행

단계별 절차

여러RPC를 실행하기 위해 다음을 실행합니다.

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

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

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

  3. Required output format 드롭다운 목록에서 출력 형식을 선택합니다.

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

  4. 이 RPC URL 엔드포인트는 자동으로 를 채우게 /rpc?exit-on-error=1 됩니다.

  5. 사용자 이름과 암호를 입력합니다.

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

    예를 들어:

  7. Submit 을 클릭합니다.

    다음 예제에서 JSON 출력 형식은 Response Body에 반환됩니다.

오류 메시지 보기

단계별 절차

여러 개의RPC를 실행할 때 오류가 발생할 수 있습니다. 오류 확인란에 Exit를 선택하면 오류가 발생하면 오류 메시지가 출력에 나타납니다.

오류 메시지를 보시다:

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

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

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

  3. Required output format 드롭다운 목록에서 출력 형식을 선택합니다.

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

  4. 이 RPC URL 엔드포인트는 자동으로 를 채우게 /rpc?exit-on-error=1 됩니다.

  5. 사용자 이름과 암호를 입력합니다.

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

    예를 들어:

  7. Submit 을 클릭합니다.

    다음 예제에서 JSON 출력 형식은 Response Body에 반환되어 Response Body 끝에서 XML 형식 오류 메시지를 볼 수 있습니다.

  8. 오류 확인란에서 Exit를 선택하지 않는 경우 오류가 발생하면 오류 메시지가 Response Body에 나타납니다.

    오류가 처리된 후에도 실행이 계속되고 그 결과는 Response Body에도 포함됩니다.

관련 문서