Questa pagina spiega come utilizzare API Explorer per provare i metodi dell'API Dataproc Metastore. API Explorer è un widget associato alla pagina di riferimento dell'API REST per un metodo. Viene visualizzato come un 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 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 o espanderlo a schermo intero facendo clic sul pulsante apposito.
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
L'API Explorer è associato alla pagina di riferimento di ogni metodo dell'API REST. Per trovare il widget, vai alla pagina di riferimento di un metodo, ad esempio la pagina di riferimento di Dataproc Metastore projects.locations.services.create.
Esegui una richiesta minima
La maggior parte dei metodi ha alcuni parametri obbligatori e altri facoltativi. Quelli obbligatori sono contrassegnati da una barra rossa finché non vengono compilati. Puoi eseguire una richiesta minima fornendo solo gli argomenti richiesti.
Il metodo services.create crea un servizio Dataproc Metastore in un progetto e una posizione scelti. I campi obbligatori sono parent
e serviceId. Per creare un servizio, fornisci il numero e l'ID posizione del progetto per principale utilizzando il moduloprojects/{projectNumber}/locations/{locationId}. Fornisci l'ID servizio per
serviceId.
I risultati dell'invocazione del metodo vengono visualizzati in una casella sotto il pulsante Esegui. In genere, la casella ha un'intestazione verde con il codice di stato HTTP 200, che indica che la richiesta è riuscita.
Se l'intestazione è rossa e contiene un codice di errore HTTP, la casella contiene il messaggio di errore. Consulta la sezione Suggerimenti per indicazioni su come risolvere gli errori.
Fornisci parametri aggiuntivi
L'elenco dei parametri visualizzato dipende dal metodo a cui è associato il widget di API Explorer. Il metodo services.create ha più parametri rispetto a parent e serviceId, ma questi sono gli unici 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 fields per limitare ulteriormente l'output
Per impostazione predefinita, l'insieme di parametri mostrato da Explorer API corrisponde ai parametri del metodo associato. Tuttavia, il widget Explorer API include anche un insieme di campi aggiuntivi non 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 aggiuntivi del widget. 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. Questa funzionalità è molto utile nel riquadro dell'Explorer API, dove l'output viene visualizzato in una casella. Spesso è necessario scorrere una grande quantità di output.
Suggerimenti
Le seguenti sezioni contengono suggerimenti per API Explorer.
Ricordati di cambiare {projectNumber} and {locationId}
Non dimenticare di sostituire {projectNumber} and {locationId} con il numero e l'ID posizione 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 tenere in considerazione quando utilizzi i moduli di API Explorer. Questi errori possono causare errori o essere accettati, ma trattati come errori ortografici nel metodo dell'API:
- Non utilizzare virgolette per i valori di campo di qualsiasi tipo.
- Assicurati di inserire tra virgolette le stringhe visualizzate all'interno dei filtri. Utilizza virgolette doppie (
") e non apostrofi ('). - Non utilizzare barre verticali o codifica URL nei campi del modulo. Se necessario, la codifica URL viene eseguita sui valori dei campi quando viene eseguito il metodo.
- Esamina il valore nella casella dei risultati dopo aver eseguito la chiamata. Potresti notare il problema lì.
- Fornisci un valore per il campo pageSize, ad esempio
2. In questo modo viene limitata la quantità di dati restituiti durante il debug della chiamata API.
Aggiungere gli URL ai preferiti per il debug
Dopo aver ottenuto l'output desiderato, aggiungi l'URL di API Explorer ai preferiti. Quando vuoi eseguire nuovamente il metodo, incolla l'URL nel browser. Vedrai 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 API Explorer, sopra il pulsante Esegui, è presente una sezione Credenziali. In genere, non è necessario modificare nulla qui.
Il meccanismo di autenticazione predefinito è Google OAuth 2.0.
Nella sezione Credenziali è presente anche un'opzione di attivazione/disattivazione Mostra ambiti. Vengono visualizzati gli ambiti Compute Engine disponibili. Per impostazione predefinita, tutti gli ambiti disponibili sono abilitati.