In questa pagina viene spiegato 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 come un riquadro con il titolo Prova questa API.
Explorer API è un modo eccellente per provare i metodi dell'API Dataproc Metastore senza dover scrivere codice. Il widget presenta un modulo che mostra i parametri per ogni 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 Schermo intero.
Prima di iniziare
- Accedi al tuo Google Cloud account. 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 senza costi per l'esecuzione, il test e il deployment dei workload.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Roles required to select or create a project
- Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
-
Create a project: To create a project, you need the Project Creator role
(
roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.createpermission. Learn how to grant roles.
Enable the Dataproc Metastore API.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (
roles/serviceusage.serviceUsageAdmin), which contains theserviceusage.services.enablepermission. Learn how to grant roles.-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Roles required to select or create a project
- Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
-
Create a project: To create a project, you need the Project Creator role
(
roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.createpermission. Learn how to grant roles.
Enable the Dataproc Metastore API.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (
roles/serviceusage.serviceUsageAdmin), which contains theserviceusage.services.enablepermission. Learn how to grant roles.
Accedi a Explorer API
Explorer API è collegato 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 alcuni facoltativi. Quelli obbligatori sono contrassegnati da una barra rossa finché non vengono compilati. Puoi eseguire una richiesta minima fornendo solo gli argomenti obbligatori.
Il metodo services.create crea un servizio Dataproc Metastore in un progetto e in 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}. Fornisci l'ID servizio per serviceId.
I risultati della chiamata al 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 è andata a buon fine.
Se l'intestazione è rossa e contiene un codice di errore HTTP, la casella contiene il messaggio di errore. Consulta Suggerimenti per indicazioni sulla risoluzione degli errori.
Fornisci parametri aggiuntivi
L'elenco dei parametri visualizzati dipende dal metodo a cui è collegato il widget Explorer API. Il metodo services.create ha più parametri di parent e serviceId, ma 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 visualizzati da Explorer API 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 l'opzione Mostra parametri standard.
Fai clic su questa opzione per visualizzare i parametri del widget aggiuntivi. Fai clic su Nascondi parametri standard per nasconderli.
Il più utile di questi parametri standard è il parametro fields, che ti consente di selezionare i campi nell'output restituito che vuoi visualizzare. Questo è molto utile nel riquadro Explorer API, dove l'output viene visualizzato in una casella. Spesso è necessario scorrere molto output.
Suggerimenti
Le seguenti sezioni contengono suggerimenti per Explorer API.
Ricorda di modificare {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
Di seguito sono riportati alcuni problemi da tenere d'occhio quando utilizzi i moduli di Explorer API. Questi errori potrebbero causare errori o essere accettati, ma essere trattati come errori di ortografia nel metodo API:
- Non utilizzare le virgolette intorno ai valori dei campi di qualsiasi tipo.
- Assicurati di inserire le virgolette nelle stringhe che appaiono 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 aver eseguito la chiamata. Potresti notare il problema lì.
- Fornisci un valore per il campo pageSize, ad esempio
2. In questo modo limiti la quantità di dati restituiti durante il debug della chiamata API.
Aggiungi ai preferiti gli URL per il debug
Dopo aver ottenuto l'output desiderato, aggiungi ai preferiti l'URL di Explorer API. Quando vuoi eseguire di nuovo il metodo, incolla l'URL nel browser. Il modulo viene visualizzato 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, 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 Mostra ambiti. Qui puoi vedere gli ambiti di Compute Engine disponibili. Per impostazione predefinita, tutti gli ambiti disponibili sono abilitati.