API 플레이그라운드

개요

Panther 콘솔의 API 플레이그라운드에서 GraphQL API 및 REST API의 작업을 시도해볼 수 있습니다.

플레이그라운드에 접근하는 방법

circle-info

다음 권한이 있어야 합니다 API 토큰 보기 플레이그라운드에 접근하려면 권한이 필요합니다—사용자 역할 수정에 대한 지침은 Panther의 역할 기반 접근 제어 문서를 참조하세요.

  1. Panther 콘솔 오른쪽 상단에서 톱니바퀴 아이콘을 클릭하세요.

  2. 드롭다운 메뉴에서 클릭하십시오 API 플레이그라운드.

  3. 창 상단의 탭을 사용하여 테스트할 API 세트를 선택하세요: GraphQL 이전에 생성한 Snowflake 사용자 이름, 예를 들면 REST.

    • 다음에 API 플레이그라운드를 방문하면 마지막으로 사용하던 API로 이동합니다.\

      Two tabs are shown: GraphQL and REST.
circle-exclamation

GraphQL 플레이그라운드

유효한 API 토큰을 입력한 후 왼쪽 상단의 "재생" 아이콘을 클릭하여 GraphQL 쿼리를 강제로 실행하세요.

The API Playground's default view shows an example query in a code editor on the left. On the right, there is a column labeled Documentation Explorer.

문서 탐색기

Panther 콘솔의 문서 탐색기는 Panther API 스키마를 살펴보는 한 가지 방법입니다. 다운로드 가능한 스키마 파일을 포함한 다른 방법에 대해서는 Panther GraphQL 스키마 알아보기.

환경에서 Fluentd 시작에 관해서는 문서 탐색기 플레이그라운드 오른쪽에 표시됩니다. 사용 가능한 쿼리 및 뮤테이션과 각 필드 및 엔티티의 설명과 타입을 표시합니다:

The image shows the Documentation Explorer that appears on the right side of the API Playground. It has a search field at the top, and a header labeled "Root Types." Under "Root Types," it lists "query: Query" and "mutation: Mutation".

직접 쿼리 작성하기

자동완성 기능과 문서 탐색기는 직접 쿼리를 작성하는 데 도움을 줍니다. 또한 페이지 상단 근처에 세 개의 유틸리티 버튼이 있습니다:

  • 정리(Prettify) GraphQL 표준에 따라 쿼리 형식을 정리하는 데 도움이 됩니다

  • 복사 요청을 발행할 클라이언트에 붙여넣기 위해 쿼리를 복사하려면

  • curl 복사 curl 명령줄 도구가 설치된 모든 UNIX 시스템에 붙여넣을 수 있는 완전한 curl 작업을 복사합니다.

Panther 웹 애플리케이션에서 복사될 curl 명령의 예:

REST 플레이그라운드

circle-info

REST 플레이그라운드는 Panther 버전 1.103부터 오픈 베타로 제공되며 모든 고객이 이용할 수 있습니다. 버그 리포트 및 기능 요청은 Panther 지원팀과 공유해 주세요.

REST 플레이그라운드를 사용하여 Panther를 탐색하고 시도해 보세요 REST API.

API 토큰 설정 방법

  1. 오른쪽 상단에서 인증(Authorize).

    An arrow is drawn to a button labeled "Authorize."
  2. 모달에서 API 키를 입력하세요.

  3. 를 선택하고 Panther가 설치된 계정 ID를 입력하십시오. 인증(Authorize)을(를). (비-JSON 로그를 업로드했고 닫기.

API 그룹 탐색

API 그룹은 각 API의 URL 경로별로 함께 모아 먼저 나열됩니다. 요청 인수 및 예제 반환 페이로드를 포함한 특정 엔드포인트의 추가 세부정보를 보려면 엔드포인트 행 오른쪽에 있는 화살표를 클릭하세요.

Under a header reading "Panther REST API," a grouping of data model endpoints is shown. There are GET (list), POST, DELETE, GET, and PUT endpoints.

요청 보내기

circle-info

요청을 성공적으로 하려면 플레이그라운드에 이미 API 토큰을 추가해야 합니다. 위의 내용을 참조하세요 API 토큰 설정 방법 , 위의.

플레이그라운드에서 요청을 보내려면:

  1. 확장된 API 엔드포인트 내에서 클릭하세요 지금 시도(Try it out).

  2. 일반 구성 매개변수 섹션에서 필요에 따라 필수 및 선택 매개변수의 값을 입력하세요.

  3. 를 선택하고 Panther가 설치된 계정 ID를 입력하십시오. 실행(Execute).

Within a GET /rules section, a "Try it out" button is circled. Two parameters are shown: cursor, and limit.

스키마 보기

API 그룹 아래에 각 데이터 유형의 스키마가 나열됩니다:

The Schema section showing all the data types grouped by name

특정 데이터 유형의 세부정보를 보려면 해당 행을 클릭하여 확장하세요:

A "RuleAPI.Rule" entity is shown. Part of the JSON body is expanded, while other parts are closed.

이 스키마는 또한 API 그룹 보기. 에서 응답(Responses) 섹션에서, 옆에 표시됩니다 예시 값(Example Value)인 경우 JSON 로그를 업로드했다면 클릭하세요 필요한 경우.

Inline schema block in the Responses portion of an API Group, showing the datatype where it is used.

마지막 업데이트

도움이 되었나요?