Questa pagina spiega come utilizzare Explorer API per provare i metodi dell'API Dataproc Metastore. Explorer API è un widget collegato alla pagina di riferimento dell'API REST per un metodo. Viene visualizzato sotto forma di riquadro con il titolo Prova questa API.
Explorer API è un ottimo modo per provare i metodi nell'API Dataproc Metastore senza dover scrivere codice. Il widget presenta un modulo con i parametri di ciascun metodo. Compila il modulo, fai clic su Esegui e guarda i risultati.
Puoi anche nascondere il widget facendo clic sul pulsante di chiusura nella parte superiore del riquadro o espanderlo a schermo intero facendo clic sul pulsante della modalità a schermo intero.
Prima di iniziare
- Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Enable the Dataproc Metastore API.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Enable the Dataproc Metastore API.
Accedere a Explorer API
Explorer API è collegato alla pagina di riferimento per ogni metodo 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.
Esegui una richiesta minima
La maggior parte dei metodi prevede alcuni parametri obbligatori e alcuni facoltativi. Quelli obbligatori sono contrassegnati con una barra rossa finché 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à scelti. I campi obbligatori sono i campi parent e serviceId. Per creare un servizio, fornisci il numero di progetto e l'ID località del progetto per parent utilizzando il modulo projects/{projectNumber}/locations/{locationId}. E fornisci l'ID servizio per serviceId.
I risultati della chiamata del metodo vengono visualizzati in una casella sotto il pulsante Esegui. In genere, la casella ha un'intestazione verde contenente il codice di stato HTTP 200, che indica che la richiesta è andata a buon fine.
Se l'intestazione è rossa e contiene un codice di errore HTTP, la casella contiene il messaggio di errore. Per suggerimenti sulla risoluzione degli errori, consulta la sezione Suggerimenti.
Fornisci parametri aggiuntivi
L'elenco dei parametri visualizzato dipende dal metodo a cui è collegato il widget Explorer API. Il metodo services.create non include solo i 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 fields per limitare ulteriormente l'output
Per impostazione predefinita, l'insieme di parametri mostrato da API Explorer corrisponde ai parametri del metodo associato. Tuttavia, il widget Explorer API ha anche un insieme di campi aggiuntivi che non sono disponibili tramite il metodo stesso.
Questi parametri sono nascosti sotto il pulsante di attivazione/disattivazione Mostra parametri standard.
Fai clic su questo pulsante di attivazione/disattivazione per visualizzare i parametri del widget aggiuntivi. Fai clic su Nascondi parametri standard per nasconderli dalla visualizzazione.
Il più utile di questi parametri standard è il parametro fields, che consente di selezionare i campi che vuoi visualizzare nell'output restituito. Ciò è molto utile nel riquadro Explorer API, dove l'output viene visualizzato in una casella. Spesso sono necessari molti output.
Suggerimenti
Le seguenti sezioni contengono suggerimenti di Explorer API.
Ricordati 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
Di seguito sono riportati alcuni problemi da verificare quando utilizzi i moduli di Explorer API. Questi errori potrebbero causare errori o essere accettati, ma essere trattati come errori ortografici nel metodo API:
- Non utilizzare virgolette per i valori dei campi di alcun 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 del modulo. Se necessario, la codifica degli URL viene eseguita sui valori dei campi quando esegui il metodo.
- Osserva il valore nella casella dei risultati dopo aver eseguito la chiamata. Potresti notare il problema.
- Fornisci un valore per il campo pageSize, ad esempio
2. Questo limita la quantità di dati che vengono restituiti durante il debug della chiamata API.
Aggiungi URL ai preferiti per il debug
Dopo aver ottenuto l'output desiderato, aggiungi l'URL Explorer API ai preferiti. Quando vuoi eseguire di nuovo il metodo, incolla l'URL nel browser. Il modulo è già compilato con i tuoi valori. Apporta le modifiche necessarie ai parametri e fai clic su Esegui per eseguire di nuovo il metodo.
Autenticazione
Nella pagina Explorer API è presente una sezione Credenziali, sopra il pulsante Esegui. In genere non è necessario apportare modifiche qui.
Il meccanismo di autenticazione predefinito è Google OAuth 2.0.
È presente anche un pulsante di attivazione/disattivazione Mostra ambiti nella sezione Credenziali. Mostra gli ambiti Compute Engine disponibili. Per impostazione predefinita, tutti gli ambiti disponibili sono abilitati.