Listar relatórios

Você pode listar os relatórios no seu projeto Google Cloud para identificar os que quer ler ou excluir antes da data de expiração.

Antes de começar

gcloud

  • Instale a CLI do Google Cloud.

  • Configure a CLI gcloud para usar sua identidade federada.

    Para mais informações, consulte Fazer login na CLI gcloud com sua identidade federada.

  • Para inicializar a CLI gcloud, execute o seguinte comando: 

    gcloud init

  • Depois de inicializar a CLI gcloud, atualize e instale os componentes necessários: 

    gcloud components update
gcloud components install beta

    • Para informações sobre como configurar a autenticação em um ambiente de produção, consulte Configurar o Application Default Credentials para código executado no Google Cloud na documentação de autenticação do Google Cloud .

    Python

    1. Instale a biblioteca de cliente Python da API App Optimize.

    2. Para usar os exemplos do Python nesta página em um ambiente de desenvolvimento local, instale e inicialize a CLI gcloud e configure o Application Default Credentials com suas credenciais de usuário.

      1. Instale a CLI do Google Cloud.

      2. Configure a CLI gcloud para usar sua identidade federada.

        Para mais informações, consulte Fazer login na CLI gcloud com sua identidade federada.

      3. Crie credenciais de autenticação local para sua conta de usuário: 

        gcloud auth application-default login

        Se um erro de autenticação for retornado, confirme se você fez login na CLI gcloud com sua identidade federada.

      Para mais informações, consulte Configurar o ADC para um ambiente de desenvolvimento local na documentação de autenticação do Google Cloud .

      Para informações sobre como configurar a autenticação em um ambiente de produção, consulte Configurar o Application Default Credentials para código executado no Google Cloud na documentação de autenticação do Google Cloud .

    REST

    Para usar as amostras da API REST nesta página em um ambiente de desenvolvimento local, use as credenciais fornecidas para a CLI gcloud.

      Instale a Google Cloud CLI e faça login na CLI gcloud com sua identidade federada.

    Saiba mais em Autenticar para usar REST na documentação de autenticação do Google Cloud .

    Para informações sobre como configurar a autenticação em um ambiente de produção, consulte Configurar o Application Default Credentials para código executado no Google Cloud na documentação de autenticação do Google Cloud .

    Funções exigidas

    Para receber as permissões necessárias para listar os recursos de relatório de um projeto, peça ao administrador para conceder a você o papel do IAM de Leitor do App Optimize (roles/appoptimize.viewer) no projeto. Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

    Também é possível conseguir as permissões necessárias usando papéis personalizados ou outros papéis predefinidos.

    Listar relatórios

    A operação de lista retorna os metadados do relatório, incluindo o nome do recurso, o escopo, as dimensões, as métricas e o tempo de expiração de cada relatório. Para baixar as informações de custo e uso solicitadas, leia os dados do relatório.

    Para listar relatórios em um projeto, siga as instruções do seu método preferido:

    gcloud

    Use o comando gcloud beta app-optimize reports list para listar os relatórios em um projeto.

    gcloud beta app-optimize reports list \
  --project=PROJECT_ID \
  --location=global

    Substitua PROJECT_ID pelo ID do projeto Google Cloud que possui os recursos de relatório que você quer listar.

    O comando gcloud processa a paginação automaticamente, retornando todos os recursos solicitados.

    Python

    O código Python a seguir usa AppOptimizeClient.list_reports() para mostrar uma lista de relatórios em um projeto.

    from google.cloud import appoptimize_v1beta

project_id = "PROJECT_ID"

# Create the App Optimize client and request the project's reports
client = appoptimize_v1beta.AppOptimizeClient()
request = appoptimize_v1beta.ListReportsRequest(
    parent=f"projects/{project_id}/locations/global"
)
page_result = client.list_reports(request=request)

# Iterate over the list of reports and display each one
for response in page_result:
    print(response)

    Substitua PROJECT_ID pelo ID do projeto Google Cloud que possui os recursos de relatório que você quer listar.

    A biblioteca de cliente processa a paginação automaticamente, gerando resultados do iterador.

    REST

    Use o seguinte comando curl para listar os relatórios de um projeto:

    curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  "https://appoptimize.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/reports?pageSize=PAGE_SIZE"

    Substitua:

    • PROJECT_ID: o ID do Google Cloud projeto que tem os recursos de relatório que você quer listar.
    • PAGE_SIZE: o número máximo de relatórios a serem retornados por página. Se omitido, a API vai usar um valor padrão. O servidor pode retornar menos relatórios do que o solicitado.

    Se a solicitação for bem-sucedida, a API vai retornar uma resposta JSON com uma lista de recursos de relatório. Confira um exemplo de resposta de chamada bem-sucedida:

    {
  "reports": [
    {
      "name": "projects/PROJECT_ID/locations/global/reports/my-first-report",
      "dimensions": [
        "location",
        "product_display_name",
        "project",
        "sku"
      ],
      "scopes": [
        {
          "project": "projects/PROJECT_ID"
        }
      ],
      "filter": "hour \u003e= now - duration(\"168h\")",
      "expireTime": "2026-02-05T18:30:39.907639266Z",
      "metrics": [
        "cost"
      ]
    },
    {
      "name": "projects/PROJECT_ID/locations/global/reports/my-second-report",
      "dimensions": [
        "location",
        "product_display_name",
        "project",
        "resource",
        "resource_type"
      ],
      "scopes": [
        {
          "project": "projects/PROJECT_ID"
        }
      ],
      "filter": "hour \u003e= now - duration(\"168h\")",
      "expireTime": "2026-02-05T18:50:25.273833857Z",
      "metrics": [
        "cost",
        "cpu_mean_utilization"
      ]
    }
  ]
}

    A matriz reports contém os metadados de cada relatório. Se a solicitação não for concluída, analise a mensagem de erro retornada pela API.

    Se a resposta incluir uma string nextPageToken, significa que há mais relatórios para recuperar.

    Verifique se há um campo nextPageToken na resposta. Se o token existir, execute o seguinte comando curl para recuperar a próxima página, incluindo o parâmetro de consulta pageToken. Você pode continuar usando o parâmetro pageSize.

    curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  "https://appoptimize.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/reports?pageToken=NEXT_PAGE_TOKEN&pageSize=PAGE_SIZE"

    Substitua:

    • NEXT_PAGE_TOKEN: o valor do nextPageToken recebido na resposta anterior.
    • PAGE_SIZE: o tamanho da página que você quer para esta solicitação.

    Repita esse processo até que a resposta não contenha mais um nextPageToken, o que indica que você recuperou todos os relatórios.

    A seguir