usage.read
Markdownv0.3.0
Lire la consommation et les compteurs d'usage d'une entité contractante.
- API
GET /v1/billing-entities/{billingEntityId}/usage - MCP
usage_read - CLI
bastide usage read
Vue de gestion. Elle n'ouvre aucune donnée applicative : c'est ce qui permet à un revendeur de suivre ce qu'il facture sans accéder aux projets de ses clients.
| Propriété | Valeur |
|---|---|
| Niveau | billing_entity |
| Rang minimal | reader |
| Rôle transversal | billing |
| Portées | billing:read |
| Compte de service | ne l'atteint pas : il ne tient de rang que sur des projets |
| Réversibilité | N — lecture seule, aucun effet |
| Idempotence | une lecture, rejouable sans précaution |
| Limites de débit, par jeton | 600 appels par 60 secondes (general) |
API
GET /v1/billing-entities/{billingEntityId}/usage — succès en 200.
| Paramètre | Où | Type | Requis | Description |
|---|---|---|---|---|
billingEntityId | chemin | texte, motif ^bil_[0-9A-HJKMNP-TV-Z]{26}$ | oui | Identifiant de entité contractante |
period | requête | texte, motif ^\d{4}-\d{2}$ | oui | Mois au format AAAA-MM |
La réponse :
| Champ | Type | Description |
|---|---|---|
billingEntityId | texte, motif ^bil_[0-9A-HJKMNP-TV-Z]{26}$ | Identifiant de entité contractante |
period | texte | |
projects | liste — chaque élément : objet (projectId, tier, computeSeconds, egressBytes, buildMinutes, storageBytes) | |
totalCents | entier |
En-têtes de la réponse : RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset, RateLimit-Policy.
Autres réponses : 400, 401, 403, 404, 409, 429, 500, 503 — communes à toute opération.
Ligne de commande
bastide usage read --billing-entity-id <valeur> --period <valeur>
| Option | Type | Requise | Défaut | Description |
|---|---|---|---|---|
--billing-entity-id | texte | oui | — | Identifiant de entité contractante |
--period | texte | oui | — | Mois au format AAAA-MM |
La commande s'exécute sans confirmation.
MCP
Outil usage_read.
| Propriété | Valeur |
|---|---|
| Lecture seule | oui |
| Destructif | non |
| Idempotent | non |
| Monde ouvert | non |
| Confirmation en deux temps | non |
| Budget de jetons du résultat | 2500 |
Erreurs
| Code | Surface | Cause |
|---|---|---|
chaine_de_mesure_absente | les deux | La consommation n'est pas mesurée sur cette installation. |
S'y ajoutent les refus communs à toute opération — entrée invalide, authentification, autorisation, cible introuvable, conflit, limite de débit, indisponibilité — que le catalogue des erreurs décrit.
Exemples
Lire la consommation d'une entité contractante sur un mois clos :
{
"billingEntityId": "bil_01JQ8ZK4M7NP2RSTVWXYZ34567",
"period": "2026-08"
}