Lister les rapports

Gérez efficacement vos rapports de l'API App Optimize en listant toutes les configurations de rapport dans votre Google Cloud projet. Cela vous permet d'identifier un rapport spécifique pour lire ses données ou le supprimer avant sa date d'expiration s'il n'est plus nécessaire.

L'opération de liste renvoie les métadonnées du rapport, y compris le nom de la ressource, le champ d'application, les dimensions, les métriques et le délai d'expiration de chaque rapport. Pour télécharger les informations sur les coûts et l'utilisation demandées, vous devez lire les données du rapport.

Avant de commencer

  1. Connectez-vous à votre Google Cloud compte. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $de crédits sans frais pour exécuter, tester et déployer des charges de travail.

  2. Installez la Google Cloud CLI.

  3. Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

  4. Pour initialiser la gcloud CLI, exécutez la commande suivante : 

    gcloud init

  5. Vérifiez que vous disposez des autorisations requises pour suivre les instructions de ce guide.

  6. Installez la Google Cloud CLI.

  7. Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

  8. Pour initialiser la gcloud CLI, exécutez la commande suivante : 

    gcloud init

  9. Vérifiez que vous disposez des autorisations requises pour suivre les instructions de ce guide.

Rôles requis

Pour obtenir les autorisations nécessaires pour lister les ressources de rapport d'un projet, demandez à votre administrateur de vous accorder le rôle IAM Lecteur App Optimize (roles/appoptimize.viewer) sur le projet. Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

Vous pouvez également obtenir les autorisations requises avec des rôles personnalisés ou d'autres rôles prédéfinis.

Répertorier les rapports

Pour lister les rapports d'un projet à l'aide de l'API REST, envoyez une requête HTTP GET au point de terminaison de la collection de rapports.

Utilisez la commande curl suivante pour lister les rapports d'un projet :

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

Remplacez les éléments suivants :

  • PROJECT_ID : ID du Google Cloud projet qui possède les ressources de rapport que vous souhaitez lister.
  • PAGE_SIZE : nombre maximal de rapports à renvoyer par page. Si vous omettez ce paramètre, l'API utilise une valeur par défaut. Le serveur peut renvoyer un nombre de rapports inférieur à celui demandé.

Si la requête aboutit, l'API renvoie une réponse JSON contenant une liste de ressources de rapport. Voici un exemple de réponse positive à un appel :

{
  "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"
      ]
    }
  ]
}

Le tableau reports contient les métadonnées de chaque rapport. Si la requête échoue, consultez le message d'erreur renvoyé par l'API.

Si la réponse inclut une chaîne nextPageToken, cela signifie qu'il existe d'autres rapports à récupérer.

Recherchez un champ nextPageToken dans la réponse. Si le jeton existe, exécutez la requête curl suivante pour récupérer la page suivante, y compris le paramètre de requête pageToken. Vous pouvez continuer à utiliser le paramètre 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"

Remplacez les éléments suivants :

  • NEXT_PAGE_TOKEN: valeur de nextPageToken reçue dans la réponse précédente.
  • PAGE_SIZE: taille de la page souhaitée pour cette requête.

Répétez ce processus jusqu'à ce que la réponse ne contienne plus de nextPageToken, ce qui indique que vous avez récupéré tous les rapports.

Étape suivante