Exemple : API REST Reports

Cet exemple montre comment utiliser l'API REST Reports des opérations cloud pour générer des rapports d'utilisation pour un abonnement cloud.

L'exemple explique comment obtenir une liste de métriques disponibles pour l'abonnement de cloud, puis générer un rapport pour une métrique et une période spécifiques.

Avant de commencer

Tous les appels à l'API nécessitent un jeton de demande de falsification de site croisée (CSRF) valide dans l'en-tête IBM® -CSRF-TOKEN de l'appel. Obtenez un jeton CSRF via POST /instance/services/csrf_token. Pour plus d'informations, voir Prévention de la falsification de requêtes entre sites (CSRF).

Récupérer des métriques

Utilisez l'appel suivant pour afficher une liste de métriques disponibles pour l'abonnement de cloud :

GET /instance/services/metrics

Une liste de métriques est renvoyée. Elle inclut les noms et les portées des métriques. La portée indique si une métrique est disponible pour tous les environnements ou seulement pour un environnement spécifique.

Générer un rapport

Vous pouvez ensuite choisir la métrique qui vous intéresse, par exemple le nombre maximal d'utilisateurs simultanés pour un jour spécifique :

GET /instance/services/reports?start_day=2019_01_01&metric=maximum_concurrent_users

Vous devez toujours inclure un jour de début dans l'appel. Si vous n'incluez pas d'environnement, l'appel renvoie des données d'utilisation pour tous les environnements. Si vous souhaitez filtrer le rapport pour afficher les données d'utilisation d'un environnement spécifique, tel que l'environnement de développement, ajoutez le paramètre environment à l'appel :

GET /instance/services/reports?start_day=2019_01_01&metric=maximum_concurrent_users&environment=dev

Si vous souhaitez afficher les données d'utilisation, par exemple pour 30 jours à compter de la date de début, modifiez l'appel comme suit :

GET /instance/services/reports?start_day=2019_01_01&days=30&metric=maximum_concurrent_users&environment=dev

Si vous êtes intéressé par la période de 30 jours précédant la date de début, utilisez une valeur négative pour le paramètre days :

GET /instance/services/reports?start_day=2019_01_01&days=-30&metric=maximum_concurrent_users&environment=dev