Listar relatórios

Gerencie seus relatórios da App Optimize API de maneira eficaz listando todas as configurações de relatório no seuprojeto. Google Cloud Isso ajuda a identificar um relatório específico para ler os dados ou excluí-lo antes da data de validade, se ele não for mais necessário.

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, é necessário ler os dados do relatório.

Antes de começar

  1. Faça login na sua Google Cloud conta do. Se você começou a usar o Google Cloud, crie uma conta para avaliar o desempenho dos nossos produtos em situações reais. Clientes novos também recebem US $300 em créditos para executar, testar e implantar cargas de trabalho.

  2. Instale a Google Cloud CLI.

  3. Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.

  4. Para inicializar a CLI gcloud, execute o seguinte comando: 

    gcloud init

  5. Verifique se você tem as permissões necessárias para concluir este guia.

  6. Instale a Google Cloud CLI.

  7. Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.

  8. Para inicializar a CLI gcloud, execute o seguinte comando: 

    gcloud init

  9. Verifique se você tem as permissões necessárias para concluir este guia.

Funções exigidas

Para ter 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 personalizados papéis ou outros predefinidos papéis.

Listar relatórios

Para listar relatórios em um projeto usando a API REST, envie uma solicitação HTTP GET ao endpoint de coleta de relatórios.

Use o seguinte curl comando 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 possui 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 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 retornará uma resposta JSON contendo 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 bem-sucedida, analise a mensagem de erro retornada pela API.

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

Verifique a resposta de um campo nextPageToken. Se o token existir, execute a seguinte solicitação 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 desejado para essa 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