Como listar serviços

Neste documento, descrevemos como listar as APIs e os serviços ativados ou disponíveis em um projeto do Google Cloud. A lista de APIs e serviços disponíveis ou ativados pode conter serviços públicos do Google Cloud, como o Pub/Sub e quaisquer APIs e serviços. compartilhados de maneira particular com você, como serviços criados usando o Cloud Endpoints. Para mais informações sobre as diferenças entre APIs e serviços públicos e privados, consulte Serviços públicos e privados.

  • Para receber ou monitorar os serviços ativados para uma organização, consulte Listar serviços ativados em uma organização.
  • Para listar os serviços em um projeto, recomendamos que você use o console do Google Cloud ou a Google Cloud CLI. Este documento descreve como usar as duas interfaces.
  • Para programar com a API Service Usage, use uma das nossas bibliotecas de cliente fornecidas.
  • Para testar a API, recomendamos que você use o comando curl. Você não precisa configurar um ambiente de aplicativo completo, mas há algumas configurações necessárias.

Antes de começar

Para listar as APIs e serviços ativados e disponíveis, você precisa dos seguintes itens:

  • Um projeto do Google Cloud. Para saber como criar um projeto do Google Cloud, consulte Como criar e gerenciar projetos.
  • As permissões corretas de Gerenciamento de identidade e acesso. Para aprender mais sobre os requisitos de IAM do Service Usage, consulte Controle de acesso.
  • Para instalar a Google Cloud CLI.
  • Se você quiser usar os exemplos curl neste guia, siga as instruções para concluir a configuração inicial em Primeiros passos. Essas etapas incluem a definição de gcurl, que é um alias autenticado do comando curlpadrão, e a definição da variável de ambiente PROJECT_NUMBER.

Listar os serviços ativados em uma organização

Para listar quais serviços estão ativados em uma organização, use o Inventário de recursos do Cloud, que permite exportar o estado de todos os projetos sob o controle de uma organização em uma única chamada RPC. O Inventário de recursos do Cloud também pode ser usado para monitorar alterações de estado. Para exportar todos os serviços ativados de uma organização específica, siga a documentação do Inventário de recursos do Cloud sobre Recursos de listagem.

Para listar as APIs ativadas para uma organização, execute o seguinte comando depois de definir os IDs da organização e do projeto de faturamento:

NOW=$(TZ=GMT date +"%Y-%m-%dT%H:%M:%SZ")
gcloud asset list \
--organization='ORGANIZATION_ID' \
--billing-project='BILLING_PROJECT_ID' \
--asset-types='serviceusage.googleapis.com/Service' \
--snapshot-time=$NOW \
--content-type='resource'

Executar o comando anterior permite que um usuário com privilégios suficientes liste o conjunto de serviços ativados para todos os projetos em uma organização.

Para testar os comandos do Inventário de recursos do Cloud, aplique-os a um projeto específico. Por exemplo, o comando a seguir lista todos os serviços ativados para um projeto específico:

NOW=$(TZ=GMT date +"%Y-%m-%dT%H:%M:%SZ")
gcloud asset list \
--project='PROJECT_ID' \
--billing-project='BILLING_PROJECT_ID' \
--asset-types='serviceusage.googleapis.com/Service' \
--snapshot-time=$NOW \
--content-type='resource'

Listar serviços ativados em um projeto

A listagem dos serviços ativados usa a cota da métrica de cota serviceusage.googleapis.com/list_enabled_requests. A cota padrão disponível é de 10 consultas por segundo (QPS).

Console

Para listar as APIs e os serviços ativados em um projeto:

  1. Acesse a página Painel de APIs do console do Google Cloud.
    Acessar a página "Painel de APIs"

  2. Selecione seu projeto do Google Cloud executando uma das seguintes ações:

    • Clique em um projeto do Google Cloud em Selecionar um projeto recente.

    • Para usar o navegador do projeto do Google Cloud, execute as seguintes etapas:

      1. Clique em Selecionar projeto para abrir o navegador do projeto do Google Cloud.
      2. Encontre seu projeto e clique no nome dele do Google Cloud.
      3. Clique em Abrir para abrir o projeto.

    A página APIs e serviços é exibida. Confira a lista de APIs ativadas no seu projeto do Google Cloud na tabela desta página.

gcloud

Para listar as APIs e os serviços ativados no seu projeto atual, execute o seguinte comando:

gcloud services list

O comando produz um resultado semelhante ao seguinte:

NAME                                              TITLE
pubsub.googleapis.com             Google Cloud Pub/Sub API
bigquery.googleapis.com           BigQuery API
cloudtrace.googleapis.com         Stackdriver Trace API
servicemanagement.googleapis.com  Google Service Management API
monitoring.googleapis.com         Stackdriver Monitoring API
storage-api.googleapis.com        Google Cloud Storage JSON API
logging.googleapis.com            Stackdriver Logging API
clouddebugger.googleapis.com      Stackdriver Debugger API
...

curl

Para listar serviços ativados, chame o método services.list com o filtro state:ENABLED.

Para listar as APIs e os serviços ativados no seu projeto, execute o seguinte comando:

gcurl "https://serviceusage.googleapis.com/v1/projects/${PROJECT_NUMBER}/services?filter=state:ENABLED"

Listar serviços disponíveis em um projeto

Listar todos os serviços disponíveis usa a cota da cota serviceusage.googleapis.com/list_available_requests. A cota padrão disponível é de 1 QPS. O conjunto de serviços disponíveis raramente muda e pode ser armazenado em cache por longos períodos.

Console

Para listar as APIs e os serviços disponíveis para você em um projeto, siga estas etapas:

  1. Acesse a página Biblioteca de APIs do Console do Google Cloud.
    Acesse a página "Biblioteca de APIs"

  2. Selecione seu projeto do Google Cloud executando uma das seguintes ações:

    • Clique em um projeto do Google Cloud em Selecionar um projeto recente.

    • Para usar o navegador do projeto do Google Cloud, execute as seguintes etapas:

      1. Clique em Selecionar projeto para abrir o navegador do projeto do Google Cloud.
      2. Encontre seu projeto e clique no nome dele do Google Cloud.
      3. Clique em Abrir para abrir o projeto.

    A tela Biblioteca de APIs é exibida. Pesquise ou role pelas APIs disponíveis nessa tela.

gcloud

Para listar as APIs e os serviços disponíveis no projeto atual, execute o seguinte comando:

gcloud services list --available

Os resultados incluem todos os serviços que já foram ativados, bem como os serviços disponíveis para ativação para o projeto atual. O comando produz um resultado semelhante ao seguinte:

NAME                                              TITLE
places-backend.googleapis.com                  Google Places API Web Service
clouderrorreporting.googleapis.com             Stackdriver Error Reporting API
analyticsreporting.googleapis.com              Google Analytics Reporting API
youtube.googleapis.com                         YouTube Data API v3
adsense.googleapis.com                         AdSense Management API
sqladmin.googleapis.com                        Google Cloud SQL API
genomics.googleapis.com                        Genomics API
adexchangebuyer.googleapis.com                 Ad Exchange Buyer API II
...

curl

Para listar os serviços disponíveis, chame o método services.list.

Para listar as APIs e os serviços disponíveis no seu projeto, execute o seguinte comando:

gcurl "https://serviceusage.googleapis.com/v1/projects/${PROJECT_NUMBER}/services"

O resultado inclui todos os serviços públicos, todos os serviços que o usuário da chamada tem a permissão servicemanagement.services.bind e todos os serviços que já foram ativados no projeto.

É possível excluir os serviços que estão ativos no projeto transmitindo filter=state:DISABLED para a chamada anterior.

Próximas etapas

Para informações sobre como ativar ou desativar serviços no seu projeto do Google Cloud, consulte Como ativar e desativar serviços.