API 탐색기 사용

이 페이지에서는 API 탐색기를 사용하여 Dataproc Metastore API 메서드를 사용하는 방법을 설명합니다. API 탐색기는 메서드의 REST API 참조 페이지에 연결된 위젯입니다. API 사용해 보기라는 제목의 패널로 표시됩니다.

API 탐색기는 코드를 작성할 필요 없이 Dataproc Metastore API에서 메서드를 사용해 볼 수 있는 좋은 방법입니다. 위젯은 각 메서드의 매개변수를 보여주는 양식을 제공합니다. 양식을 작성하고 실행을 클릭한 다음 결과를 확인합니다.

패널 위에서 닫기 버튼을 클릭하여 위젯을 숨기거나 전체 화면 버튼을 클릭하여 전체 화면으로 확장할 수 있습니다.

시작하기 전에

  1. Google Cloud 계정에 로그인합니다. Google Cloud를 처음 사용하는 경우 계정을 만들고 Google 제품의 실제 성능을 평가해 보세요. 신규 고객에게는 워크로드를 실행, 테스트, 배포하는 데 사용할 수 있는 $300의 무료 크레딧이 제공됩니다.
  2. Google Cloud Console의 프로젝트 선택기 페이지에서 Google Cloud 프로젝트를 선택하거나 만듭니다.

    프로젝트 선택기로 이동

  3. Dataproc Metastore API를 사용 설정합니다.

    API 사용 설정

  4. Google Cloud Console의 프로젝트 선택기 페이지에서 Google Cloud 프로젝트를 선택하거나 만듭니다.

    프로젝트 선택기로 이동

  5. Dataproc Metastore API를 사용 설정합니다.

    API 사용 설정

API 탐색기에 액세스

API 탐색기는 각 REST API 메서드의 참조 페이지에 연결됩니다. 위젯을 찾으려면 Dataproc Metastore projects.locations.services.create 참조 페이지와 같은 메서드의 참조 페이지로 이동합니다.

최소 요청 실행

대부분의 메서드에는 필수 매개변수와 일부 선택 매개변수가 있습니다. 필수 매개변수는 채워질 때까지 빨간색 막대로 표시됩니다. 필수 인수만 제공하여 최소 요청을 실행할 수 있습니다.

services.create 메서드는 선택한 프로젝트 및 위치에 Dataproc Metastore 서비스를 만듭니다. 필수 필드는 parentserviceId 필드입니다. 서비스를 만들려면 projects/{projectNumber}/locations/{locationId} 양식을 사용해서 parent에 대해 프로젝트의 프로젝트 번호 및 위치 ID를 제공합니다. serviceId에 대해 서비스 ID를 제공합니다.

사용해 보기

메서드 호출 결과는 실행 버튼 아래의 상자에 표시됩니다. 일반적으로 상자에는 HTTP 상태 코드 200이 있는 녹색 헤더가 있으며, 이는 요청이 성공했음을 나타냅니다.

헤더가 빨간색이고 헤더에 HTTP 실패 코드가 포함된 경우 상자에 오류 메시지가 포함됩니다. 오류 해결에 대한 도움말은 도움말을 참조하세요.

추가 매개변수 제공

표시되는 매개변수 목록은 API 탐색기 위젯이 연결된 메서드에 따라 다릅니다. services.create 메서드에 매개변수가 더 있지만 필수 매개변수는 parentserviceId뿐입니다.

서버에서 완료된 요청이 무시되도록 선택사항인 requestId 매개변수를 사용하여 고유한 요청 ID를 지정할 수 있습니다.

필드를 사용하여 추가 출력 제한

기본적으로 API 탐색기에 표시되는 매개변수 집합은 연결된 메서드의 매개변수에 해당합니다. 하지만 API 탐색기 위젯에는 메서드 자체를 통해 사용할 수 없는 추가 필드 집합도 있습니다.

이러한 매개변수는 표준 매개변수 표시 전환에 숨겨져 있습니다.

이 전환을 클릭하여 추가 위젯 매개변수를 노출합니다. 표준 매개변수 숨기기를 클릭하여 보기에서 숨깁니다.

이러한 표준 매개변수의 가장 유용한 방법은 fields 매개변수입니다. 이 매개변수를 사용하면 반환된 출력의 필드를 선택할 수 있습니다. 이는 상자에 출력이 표시되는 API 탐색기 패널에서 매우 유용합니다. 스크롤해야 할 출력은 종종 많습니다.

다음 섹션에는 API 탐색기 팁이 포함되어 있습니다.

{projectNumber} and {locationId} 반드시 변경

{projectNumber} and {locationId}를 프로젝트 번호 및 위치 ID로 바꿔야 합니다. API에서 번호 대신 프로젝트 ID도 사용할 수 있습니다.

값 관련 문제

다음은 API 탐색기 양식을 사용할 때 주의해야 할 사항입니다. 이러한 실수로 인해 오류가 발생하거나 수락될 수 있지만 API 메서드에서 철자 오류로 처리될 수 있습니다.

  • 어떠한 유형의 필드 값도 따옴표로 묶지 않습니다.
  • 필터 안에 표시되는 문자열을 따옴표로 묶어야 합니다. 아포스트로피(') 대신 큰 따옴표(")를 사용합니다.
  • 양식 필드에 백슬래시 또는 URL 인코딩을 사용하지 마세요. 필요한 경우 메서드를 실행할 때 필드 값에 대해 URL 인코딩이 수행됩니다.
  • 호출을 실행한 후 결과 상자의 값을 확인합니다. 문제가 있을 수 있습니다.
  • pageSize 필드의 값(예: 2)을 제공합니다. 이렇게 하면 API 호출을 디버그할 때 반환되는 데이터 양이 제한됩니다.

디버깅을 위한 URL 북마크

원하는 출력을 얻으면 API 탐색기 URL을 북마크에 저장합니다. 이 메서드를 다시 실행하려는 경우 브라우저에 이 URL을 붙여넣습니다. 값이 이미 채워진 양식이 표시됩니다. 매개변수를 필요한 대로 변경하고 실행을 클릭하여 메서드를 다시 실행합니다.

인증

API 탐색기 페이지의 실행 버튼 위에 사용자 인증 정보 섹션이 있습니다. 일반적으로 여기에서 아무것도 변경할 필요가 없습니다.

기본 인증 메커니즘은 Google OAuth 2.0입니다.

사용자 인증 정보 섹션에 범위 표시 전환도 있습니다. 이를 사용하면 사용 가능한 Compute Engine 범위가 표시되며, 기본적으로 사용 가능한 모든 범위가 사용 설정됩니다.

다음 단계