Utilizzare API Explorer

In questa pagina viene spiegato come utilizzare Explorer API per provare i metodi dell'API Dataproc Metastore. API Explorer è un widget collegato alla pagina di riferimento dell'API REST per un metodo. che viene visualizzato come riquadro dal titolo Prova questa API.

API Explorer è un ottimo modo per provare i metodi nell'API Dataproc Metastore senza dover scrivere codice. Il widget presenta un modulo che mostra i parametri per ciascun metodo. Compila il modulo, fai clic su Esegui e visualizza i risultati.

Puoi anche nascondere il widget facendo clic sul pulsante di chiusura nella parte superiore del riquadro oppure espanderlo a schermo intero facendo clic sul pulsante della modalità a schermo intero.

Prima di iniziare

  1. Accedi al tuo account Google Cloud. Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti gratuiti per l'esecuzione, il test e il deployment dei carichi di lavoro.
  2. Nella pagina del selettore dei progetti in Google Cloud Console, seleziona o crea un progetto Google Cloud.

    Vai al selettore progetti

  3. Attiva l'API Dataproc Metastore.

    Abilita l'API

  4. Nella pagina del selettore dei progetti in Google Cloud Console, seleziona o crea un progetto Google Cloud.

    Vai al selettore progetti

  5. Attiva l'API Dataproc Metastore.

    Abilita l'API

Accedere a Explorer API

L'Explorer API è allegato alla pagina di riferimento per ciascun metodo dell'API REST. Per trovare il widget, vai alla pagina di riferimento di un metodo, ad esempio la pagina di riferimento per Dataproc Metastore projects.locations.services.create.

Eseguire una richiesta minima

La maggior parte dei metodi ha alcuni parametri obbligatori e altri facoltativi. Quelli obbligatori sono contrassegnati da una barra rossa fino a quando non vengono riempiti. Puoi eseguire una richiesta minima fornendo solo gli argomenti richiesti.

Il metodo services.create crea un servizio Dataproc Metastore in un progetto e una località selezionati. I campi obbligatori sono i campi parent e serviceId. Per creare un servizio, fornisci il numero e l'ID località del progetto per il tuo parent con il modulo projects/{projectNumber}/locations/{locationId}. Fornisci l'ID servizio per serviceId.

Prova!

I risultati della chiamata del metodo vengono visualizzati in una casella sotto il pulsante Esegui. In genere, il riquadro ha un'intestazione verde con il codice di stato HTTP 200, che indica la richiesta riuscita.

Se l'intestazione è rossa e contiene un codice di errore HTTP, la casella contiene il messaggio di errore. Consulta i Suggerimenti per suggerimenti su come risolvere gli errori.

Fornire parametri aggiuntivi

L'elenco dei parametri visualizzati dipende dal metodo a cui è associato il widget Explorer API. Il metodo services.create non si limita solo ai parametri parent e serviceId, ma sono gli unici parametri obbligatori.

Puoi utilizzare il parametro facoltativo requestId per specificare un ID richiesta univoco per consentire al server di ignorare la richiesta, se è stata completata.

Utilizza i campi per limitare ulteriormente l'output

Per impostazione predefinita, il set di parametri mostrato da Explorer API corrisponde ai parametri del metodo associato. Tuttavia, il widget Explorer API ha anche una serie di campi aggiuntivi che non sono disponibili tramite il metodo stesso.

Questi parametri sono nascosti sotto l'opzione di attivazione/disattivazione Mostra parametri standard.

Fai clic su questo pulsante di attivazione/disattivazione per visualizzare i parametri widget aggiuntivi. Fai clic su Nascondi parametri standard per nasconderli.

Il più utile di questi parametri standard è il parametro fields, che consente di selezionare i campi dell'output restituito che vuoi visualizzare. È molto utile nel riquadro Explorer API, dove l'output viene visualizzato in un riquadro. Spesso l'output è molto elevato.

Suggerimenti

Le seguenti sezioni contengono suggerimenti di Explorer API.

Ricorda di modificare {projectNumber} and {locationId}

Non dimenticare di sostituire {projectNumber} and {locationId} con il numero e l'ID località del progetto. Tieni presente che l'API accetta anche l'ID progetto al posto del numero.

Problemi con i valori

Ecco alcuni problemi da tenere presenti quando utilizzi i moduli Explorer API. Questi errori potrebbero causare errori o essere accettati, ma essere considerati come errori di ortografia nel metodo dell'API:

  • Non utilizzare le virgolette intorno ai valori dei campi di qualsiasi tipo.
  • Assicurati di citare le stringhe visualizzate all'interno dei filtri. Utilizza le virgolette doppie (") e non gli apostrofi (').
  • Non utilizzare barre rovesciate o codifica degli URL nei campi dei moduli. Se necessario, la codifica degli URL viene eseguita sui valori dei campi quando esegui il metodo.
  • Guarda il valore nella casella dei risultati dopo aver eseguito la chiamata. Potresti notare il problema.
  • Specifica un valore per il campo pageSize, ad esempio 2. Questo limita la quantità di dati che vengono restituiti durante il debug della chiamata API.

URL dei preferiti per il debug

Dopo aver ottenuto l'output desiderato, aggiungi l'URL di Explorer API ai preferiti. Quando vuoi eseguire di nuovo il metodo, incolla l'URL nel browser. Il modulo è già compilato con i valori. Apporta le modifiche necessarie ai parametri e fai clic su Esegui per eseguire nuovamente il metodo.

Autenticazione

Nella pagina Explorer API è disponibile una sezione Credentials, sopra il pulsante Execute (Esegui). In genere non è necessario modificare nulla qui.

Il meccanismo di autenticazione predefinito è Google OAuth 2.0.

Nella sezione Credenziali è presente anche un pulsante di attivazione/disattivazione Mostra ambiti. mostra gli ambiti di Compute Engine disponibili. Per impostazione predefinita, sono abilitati tutti gli ambiti disponibili.

Passaggi successivi