Suivre la consommation

Ce que fait le suivi de la consommation

La plateforme écrit un rapport par jour. Chaque rapport compte les charges protégées de la journée et les points consommés. Voir Comment la licence fonctionne.

Le suivi lit ces rapports. Il donne quatre choses : la consommation par jour et par type de charge, le solde de points, une projection du solde, et le journal des rapports.

Le portail montre le solde, la tolérance, l'engagement et les lots sur la page Licence. La consommation par jour, la projection et le journal des rapports passent par l'API REST.

Le suivi ne donne que des nombres. Il ne donne jamais un nom de machine, un nom de fichier, un nom d'utilisateur, une adresse email ni un nom de tenant.

Prérequis

• Une licence importée au moins une fois. Le premier rapport porte sur le jour du premier import. Voir Importer une licence.
• Pour la page Licence du portail : le rôle Administrateur plateforme. Voir Rôles et droits.
• Pour la consommation par jour et la projection : le droit Lecture. Une session du portail, une clé API de MSP avec la portée read ou un accès MCP avec la portée read conviennent.
• Pour le journal des rapports : le rôle Administrateur plateforme et une session du portail. Une clé API et un accès MCP ne peuvent jamais lire le journal.

Dans les exemples, remplacez <serveur> par le nom de votre portail BaaStide, et <clé> par une clé API de votre MSP.

L'unité des montants

Le portail affiche des points. L'API REST et les outils MCP donnent des millipoints. Un point vaut 1 000 millipoints. Divisez par 1 000 pour obtenir des points.

Les quatre types de charge

Type dans l'API	Ce qu'il compte
agent_server	Les machines du parc avec un agent.
agent_workstation	Réservé. Aujourd'hui, toute machine compte comme agent_server.
vm	Les machines virtuelles d'un hôte Hyper-V, dans une politique VM active qui ne les exclut pas.
m365_user	Les utilisateurs facturables d'un tenant Microsoft 365 protégé.

Chaque rapport porte une ligne par type, même quand le compte vaut zéro.

Lire le solde dans le portail

1. Connectez-vous au portail avec le rôle Administrateur plateforme.
2. Ouvrez Plateforme.
3. Choisissez Licence.
4. Lisez le bloc Points. Il donne le Solde, la Tolérance accordée, la Tolérance utilisée quand elle a servi, l'Engagement et le tableau Lots. Avec une facturation mensuelle, il donne l'Utilisation ce mois-ci et le plafond du mois.

Le détail de chaque champ est dans Comment la licence fonctionne.

Lire la consommation des 30 derniers jours

1. Ouvrez un terminal sur un poste qui atteint le portail.

2. Lancez cette commande :

   curl -sS -H 'Authorization: Bearer <clé>' 'https://<serveur>/api/license/usage?days=30'

3. Lisez le tableau days de la réponse. Il donne un jour par ligne, du plus récent au plus ancien.

4. Lisez le tableau workloads de chaque jour. Il donne le compte et les points de chaque type de charge.

Le paramètre days accepte une valeur de 1 à 90. Sans ce paramètre, la réponse porte sur 30 jours.

La réponse donne ces champs :

Champ	Ce qu'il donne
state	L'état de la licence maintenant. Voir États de la licence et blocages.
billing	Le mode de facturation : prepaid, postpaid ou none. Il vaut null quand la plateforme n'a pas de licence.
days[].day	Le jour du rapport, en heure UTC.
days[].state	L'état de la licence à la fin de ce jour.
days[].charged	false quand aucune sauvegarde n'était autorisée pendant tout le jour. Ce jour ne consomme rien.
days[].consumed	Les points du jour, en millipoints.
days[].workloads[]	Par type de charge : type, count et consumed.
balance	Avec des points prépayés : le balance, la tolérance accordée (overdraft) et la tolérance utilisée (overdraft_in_use).
month_usage	Avec une facturation mensuelle : le mois, la consommation du mois et le plafond.
projection	La projection du solde. Voir plus bas.

Un jour avec charged: false garde ses comptes de charges. Ses points valent zéro.

Lire la consommation avec un assistant IA

1. Activez l'accès MCP de votre MSP, et donnez la portée read à l'assistant.
2. Demandez la consommation de la plateforme à l'assistant.
3. L'assistant appelle l'outil license_usage. Il reçoit les mêmes nombres que la route GET /license/usage.

L'outil license_usage ne lit que des nombres. Il ne peut ni importer une licence, ni lire le journal des rapports, ni exporter une demande de licence.

Lire la projection du solde

La projection est un calcul local. Elle vaut seulement pour une licence avec des points prépayés et un engagement annuel en cours.

1. Lancez la commande de la consommation, décrite plus haut.
2. Lisez l'objet projection de la réponse.

Champ	Ce qu'il donne
daily_pace	Le rythme : la consommation moyenne par jour des derniers rapports, en millipoints.
pace_days	Le nombre de rapports dans ce rythme, au plus 30.
ends_at	La fin de l'engagement annuel. La projection s'arrête à cette date.
balance_at_end	Le solde estimé à la fin de l'engagement.
zero_day	Le premier jour où le solde arrive à zéro, ou null quand il reste positif.
zero_before_end	true quand le solde arrive à zéro avant la fin de l'engagement.

La projection applique le rythme à chaque jour qui reste. Elle fait expirer chaque lot à sa date. Quand zero_before_end vaut true, la plateforme envoie l'alerte « Solde à zéro avant la fin de l'année ». Voir États de la licence et blocages.

La projection vaut null dans ces quatre cas : la licence n'a pas de points prépayés, la licence n'a pas d'engagement, l'engagement est terminé, ou la licence est expirée.

Lire le journal des rapports

Le journal garde tous les rapports de la plateforme, du plus récent au plus ancien.

1. Connectez-vous au portail avec le rôle Administrateur plateforme.
2. Dans le même navigateur, ouvrez l'adresse https://<serveur>/api/admin/license/reports.
3. Lisez le tableau items. Chaque ligne donne un rapport.
4. Pour la page suivante, ajoutez le next_cursor de la réponse : https://<serveur>/api/admin/license/reports?cursor=<valeur>.

Chaque ligne donne ces champs :

Champ	Ce qu'il donne
seq	Le numéro du rapport. Il monte de 1 à chaque rapport.
day	Le jour du rapport, en heure UTC.
report_id	L'identifiant du rapport.
state	L'état de la licence à la fin de ce jour.
charged	false quand le jour ne consomme rien.
consumed	Les points du jour, en millipoints.
balance_after	Avec des points prépayés : le solde après ce jour.
month_to_date	Avec une facturation mensuelle : la consommation du mois jusqu'à ce jour.
created_at	L'heure d'écriture du rapport. Elle est plus tardive que day quand la plateforme a été arrêtée.

Le paramètre limit fixe le nombre de lignes, de 1 à 100. Sans ce paramètre, la réponse porte 50 lignes.

Lire un rapport et sa signature

1. Relevez le seq du rapport dans le journal.
2. Dans le navigateur connecté au portail, ouvrez l'adresse https://<serveur>/api/admin/license/reports/<seq>.
3. Lisez le champ payload. Il donne le rapport en clair : le jour, les charges de chaque type avec leur tarif, les points, le solde après ce jour, la version de la plateforme et le nombre d'agents par version.
4. Gardez le champ token quand BaaStide vous demande le rapport signé. C'est le rapport sous sa forme signée.

Vérifier la chaîne des rapports

La plateforme signe chaque rapport et le lie au rapport précédent. Elle sait donc dire si un rapport a été modifié ou supprimé en dehors d'elle.

1. Dans le navigateur connecté au portail, ouvrez l'adresse https://<serveur>/api/admin/license.
2. Lisez l'objet journal.
3. Vérifiez que status vaut ok. La valeur broken veut dire qu'un rapport ne passe pas une vérification.
4. Quand status vaut broken, relevez le seq et le problem, puis demandez de l'aide à BaaStide.
5. Lisez report_count. Il donne le nombre de rapports du journal.

La même réponse donne aussi :

• workloads : le compte des charges actives de chaque type aujourd'hui, et la limite de la licence quand elle existe. Dans cette vue, le compte des machines virtuelles vaut toujours zéro. Lisez le compte des machines virtuelles dans les rapports quotidiens ;
• last_report : le dernier rapport écrit, avec son seq, son jour et ses points ;
• clock : la date la plus haute que la plateforme a vue, et le retard de l'horloge du serveur en secondes.

Lire le volume stocké par jour

Le volume stocké est une autre mesure. Il se compte en octets, pas en points. La licence ne le décompte pas.

1. Ouvrez un terminal sur un poste qui atteint le portail.

2. Lancez cette commande, avec la période voulue :

   curl -sS -H 'Authorization: Bearer <clé>' \
     'https://<serveur>/api/usage-daily?from=2026-10-01&to=2026-10-31'

3. Lisez le tableau items. Chaque ligne donne un endpoint et un jour.

4. Lisez stored_bytes pour le volume dans le dépôt, et orchestrated_bytes pour le volume de la source.

Les paramètres from et to sont obligatoires, au format AAAA-MM-JJ. Les paramètres endpoint_id et client_id limitent la réponse à une machine ou à un client.

Limites et précautions

• Le rapport d'un jour est écrit après la fin de ce jour, en heure UTC. La consommation du jour en cours n'existe donc pas encore.
• La plateforme vérifie les rapports dus au démarrage, puis toutes les dix minutes. Un rapport peut arriver avec quelques minutes de retard.
• Quand la plateforme a été arrêtée pendant quelques jours, elle écrit les rapports manquants au redémarrage, dans l'ordre des jours. Leur created_at est plus tardif que leur day.
• Les montants de l'API sont en millipoints. Le portail affiche des points. Ne comparez pas les deux sans diviser par 1 000.
• La licence couvre toute la plateforme. Sur une plateforme avec plusieurs MSP, ces nombres portent sur toute la plateforme, pas sur un seul MSP.
• Un rapport ne peut plus être modifié ni supprimé. N'essayez pas de corriger un rapport : demandez de l'aide à BaaStide.
• Le journal des rapports et l'état complet de la licence demandent une session du portail. Une clé API et un accès MCP les reçoivent toujours en refus.
• Le solde du portail et la projection sont calculés sur la plateforme, sans accès à Internet. BaaStide applique le même calcul sur les mêmes rapports.

Référence

• API REST : Get license usage, Get license overview et List usage daily.
• Outils MCP : license_usage et license_status.

Les routes GET /admin/license et GET /admin/license/reports sont des routes d'administration de la plateforme. Elles ne sont pas dans la référence de l'API publique.