Questa pagina spiega 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. 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 mostra un modulo con 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 pannello o espanderlo a schermo intero facendo clic sul pulsante 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.
- Non utilizzare virgolette intorno ai valori dei campi di qualsiasi tipo.
- Assicurati di inserire le stringhe tra virgolette all'interno dei filtri. Utilizza le virgolette
doppie (
") e non gli apostrofi ('). - Non utilizzare barre rovesciate o codifica URL nei campi del modulo. Se necessario, la codifica URL viene eseguita sui valori dei campi quando esegui il metodo.
- Esamina il valore nella casella dei risultati dopo l'esecuzione della chiamata. Potresti notare il problema lì.
- Fornisci un valore per il campo pageSize, ad esempio
2. In questo modo si limita la quantità di dati restituiti durante il debug della chiamata API.
Accedere a Explorer API
API Explorer è collegato alla pagina di riferimento per 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 con 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 località scelti. I campi obbligatori sono parent
e serviceId. Per creare un servizio, fornisci il numero di progetto e l'ID località del tuo progetto per parent utilizzando il modulo projects/{projectNumber}/locations/{locationId}. e fornisci l'ID servizio per
serviceId.
I risultati dell'invocazione 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 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. Consulta i suggerimenti per risolvere gli errori.
Fornisci parametri aggiuntivi
L'elenco dei parametri visualizzati dipende dal metodo a cui è collegato il widget
API Explorer. Il metodo services.create ha più parametri di 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 i campi 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 dispone anche di un insieme di campi aggiuntivi non 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 aggiuntivi del widget. Fai clic su Nascondi parametri standard per nasconderli dalla visualizzazione.
Il più utile di questi parametri standard è il parametro fields, che ti consente di selezionare i campi nell'output restituito che vuoi visualizzare. Questa funzionalità è molto utile nel pannello Explorer API, in cui l'output viene visualizzato in una casella. Spesso è necessario scorrere molti output.
Suggerimenti
Le seguenti sezioni contengono suggerimenti per Explorer API.
Ricordati di cambiare {projectNumber} and {locationId}
Non dimenticare di sostituire {projectNumber} and {locationId} con il numero e l'ID località del tuo progetto. Tieni presente che l'API accetta anche l'ID progetto al posto
del numero.
Problemi con i valori
Ecco alcuni problemi da tenere d'occhio quando utilizzi i moduli di Explorer API. Questi errori potrebbero causare errori o essere accettati, ma trattati come errori di ortografia nel metodo API:
URL dei preferiti per il debug
Dopo aver ottenuto l'output che ti interessa, aggiungi l'URL di API Explorer 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 nuovamente 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 pulsante di attivazione/disattivazione Mostra ambiti. Questa mostra gli ambiti di Compute Engine disponibili. Per impostazione predefinita, tutti gli ambiti disponibili sono abilitati.