Esta página explica como usar o API Explorer para experimentar os métodos da API Dataproc Metastore. O Explorador de APIs é um widget anexado à página de referência da API REST para um método. Aparece como um painel com o título Experimentar esta API.
O Explorador de APIs é uma excelente forma de experimentar métodos na API Dataproc Metastore sem ter de escrever código. O widget apresenta um formulário que mostra os parâmetros de cada método. Preencha o formulário, clique em Executar e veja os resultados.
Também pode ocultar o widget clicando no botão de fechar na parte superior do painel ou expandi-lo para ecrã inteiro clicando no botão de ecrã inteiro.
Antes de começar
- 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.
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
(
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
(
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. - Não use aspas à volta dos valores dos campos de nenhum tipo.
- Certifique-se de que coloca as strings apresentadas nos filtros entre aspas. Use aspas duplas (
") e não apóstrofos ('). - Não use barras invertidas nem codificação de URL em campos de formulários. Se necessário, a codificação de URL é realizada nos valores dos campos quando executa o método.
- Consulte o valor na caixa de resultados após a execução da chamada. Pode notar o problema aí.
- Forneça um valor para o campo pageSize, como
2. Isto limita a quantidade de dados devolvidos à medida que depura a chamada API.
Aceda ao Explorador de APIs
O Explorador de APIs está anexado à página de referência de cada método da API REST. Para encontrar o widget, aceda à página de referência de um método, por exemplo, a
página de referência do Dataproc Metastore projects.locations.services.create.
Executar um pedido mínimo
A maioria dos métodos tem alguns parâmetros obrigatórios e outros opcionais. Os campos obrigatórios estão marcados com uma barra vermelha até serem preenchidos. Pode executar um pedido mínimo fornecendo apenas os argumentos necessários.
O método services.create cria um serviço de Metastore do Dataproc num projeto e numa localização escolhidos. Os campos obrigatórios são os campos parent
e serviceId. Para criar um serviço, indique o número do projeto e o ID da localização do seu projeto para parent através do formulário projects/{projectNumber}/locations/{locationId}. E forneça o ID do serviço para
serviceId.
Os resultados da invocação do método são apresentados numa caixa abaixo do botão Executar. Normalmente, a caixa tem um cabeçalho verde com o código de estado HTTP 200, o que indica que o pedido foi bem-sucedido.
Se o cabeçalho estiver a vermelho e contiver um código de falha HTTP, a caixa contém a mensagem de erro. Consulte as sugestões para obter indicações sobre como resolver erros.
Forneça parâmetros adicionais
A lista de parâmetros que vê depende do método ao qual o widget do API Explorer está anexado. O método services.create tem mais do que apenas os parâmetros parent e serviceId, mas são os únicos parâmetros obrigatórios.
Pode usar o parâmetro opcional requestId para especificar um ID do pedido exclusivo para permitir que o servidor ignore o pedido se tiver sido concluído.
Use campos para limitar ainda mais a saída
Por predefinição, o conjunto de parâmetros que o Explorador de APIs mostra corresponde aos parâmetros do método associado. No entanto, o widget do Explorador de APIs também tem um conjunto de campos adicionais que não estão disponíveis através do próprio método.
Estes parâmetros estão ocultos no botão Mostrar parâmetros padrão.
Clique neste botão para expor os parâmetros adicionais do widget. Clique em Ocultar parâmetros padrão para os ocultar da vista.
O mais útil destes parâmetros padrão é o parâmetro fields, que lhe permite selecionar os campos no resultado devolvido que quer ver. Isto é muito útil no painel do explorador de APIs, onde o resultado é apresentado numa caixa. Muitas vezes, existe muito resultado para percorrer.
Dicas
As secções seguintes contêm sugestões do API Explorer.
Lembre-se de alterar {projectNumber} and {locationId}
Não se esqueça de substituir {projectNumber} and {locationId} pelo número e ID de localização do seu projeto. Tenha em atenção que a API também aceita o ID do projeto em vez do número.
Problemas com os valores
Seguem-se alguns problemas a ter em atenção quando usar os formulários do API Explorer. Estes erros podem causar erros ou podem ser aceites, mas são tratados como erros ortográficos no método da API:
Marque URLs para depuração
Depois de obter o resultado pretendido, adicione o URL do API Explorer aos marcadores. Quando quiser executar o método novamente, cole o URL no navegador. O formulário já está preenchido com os seus valores. Faça as alterações necessárias aos parâmetros e clique em Executar para executar o método novamente.
Autenticação
Existe uma secção Credenciais na página do Explorador de APIs, acima do botão Executar. Normalmente, não tem de alterar nada aqui.
O mecanismo de autenticação predefinido é Google OAuth 2.0.
Também existe um botão para Mostrar âmbitos na secção Credenciais. Isto mostra-lhe os âmbitos do Compute Engine que tem disponíveis. Por predefinição, todos os âmbitos disponíveis estão ativados.