A propos des perspectives de l'API
En tant que GitHub Enterprise Cloud propriétaire d'une organisation, vous et vos utilisateurs désignés pouvez visualiser l'activité de l'API REST pour l'ensemble de votre organisation ou pour des applications et des utilisateurs spécifiques. Cela vous aide à comprendre les sources de votre activité API REST et à gérer vos limites de taux primaires, en vous donnant une visibilité sur la période, les applications et les points d'extrémité API concernés. Pour en savoir plus sur les limites du taux primaire, consultez Limites de débit pour l'API REST.
Remarque
Actuellement, cette fonctionnalité ne prend en charge que la catégorie core des points d'extrémité de l'API REST et les limites de taux primaires. L’activité d’API pour la recherche, GitHub Actions (à l’aide du secret GITHUB_TOKEN) et la limitation de débit secondaire ne sont pas prises en charge. Pour plus d'informations sur les catégories de l'API, consultez Points de terminaison d’API REST pour les limites de débit. Pour en savoir plus sur les limites de taux primaires et secondaires, consultez Limites de débit pour l'API REST.
Permettre l'accès aux données de l'API
Les propriétaires d'organisations peuvent créer des rôles d'organisation personnalisés pour permettre aux personnes d'afficher des informations sur les API pour leur organisation. Pour permettre aux utilisateurs d'y accéder, sélectionnez l'autorisation Voir les informations de l'API de l'organisation lors de la création d'un rôle d'organisation personnalisé. Attribuez ensuite le rôle personnalisé à un membre de l'organisation ou à une équipe. Pour plus d’informations, consultez « Autorisations des rôles d’organisation personnalisés ».
Avertissement
L'octroi d'un accès aux non-titulaires de l'organisation leur permettra de consulter les informations de l'API pour tous les utilisateurs et toutes les applications de l'organisation, d'où la nécessité de prendre en compte la question de la confidentialité.
Comprendre l'agrégation des données de l'API
La fonction de sélection de la période vous permet d'afficher les données de l'API sur des périodes prédéfinies ou sur une période personnalisée, comme indiqué dans le tableau suivant. Par défaut, les données sont présentées en temps universel coordonné (UTC). Vous pouvez modifier les données affichées en les remplaçant par le fuseau horaire de votre navigateur dans le menu déroulant « Période » en haut à droite de la page.
| Période | Description |
|---|---|
| Dernières 30 minutes | Données des 30 dernières minutes jusqu'au moment où la page est consultée. |
| Dernière heure | Données de la dernière heure au moment de la visualisation de la page. |
| 3 dernières heures | Données des 3 dernières heures jusqu'au moment où la page est consultée. |
| 12 dernières heures | Données des 12 dernières heures au moment de la consultation de la page. |
| Dernières 24 heures | (Par défaut) Données des dernières 24 heures jusqu'au moment de la consultation de la page. |
| 7 derniers jours | Données des 7 derniers jours jusqu'à la date de consultation de la page. |
| 31 derniers jours | Données des 31 derniers jours jusqu'à la date de consultation de la page. |
| Personnalisé | Données provenant d'une date et d'une plage horaire personnalisées que vous fournissez. Les gammes personnalisées doivent commencer au cours des 31 derniers jours. |
Visualisation des informations sur l'API pour une organisation
-
Dans le coin supérieur droit de GitHub, cliquez sur votre photo de profil, puis sur Vos organisations.
-
Cliquez sur le nom de votre organisation.
-
Sous le nom de votre organisationl, cliquez sur Insights.
-
Dans le menu de navigation « Insights », cliquez sur REST API.
-
En option, pour sélectionner une période de temps pour laquelle afficher les perspectives de l'API, choisissez une option dans le menu déroulant Période en haut à droite de la page. Pour plus d'informations, consultez Comprendre l'agrégation des informations de l'API.
-
En option, pour basculer entre l'affichage des dates et heures en temps universel coordonné (UTC) et le fuseau horaire local utilisé par votre navigateur, sélectionnez « UTC » ou « Local » dans le menu déroulant de la période en haut à droite de la page.
-
En option, pour sélectionner la granularité de l'affichage des requêtes API REST sur le graphique, choisissez une option dans le menu déroulant Intervalle en haut à droite de la page. Les grands intervalles affichent des résumés de l'activité de l'API sur le graphique, tandis que les intervalles plus petits affichent plus de détails pour la période sélectionnée. Le graphique n'est pas automatiquement mis à jour pour montrer les nouvelles activités.
La période et l'intervalle sélectionnés font automatiquement partie de l'URL de la page, de sorte que si vous partagez l'URL avec quelqu'un, cette personne verra la même vue.
Visualisation des informations sur les API pour les applications et les utilisateurs d'une organisation
Le tableau « Acteurs » affiche GitHub Apps et les utilisateurs qui ont effectué des demandes d'API REST dans l'organisation actuelle au cours de la période sélectionnée. Le tableau n'est pas automatiquement mis à jour en fonction des nouvelles activités.
- Tout d'abord, affichez les informations sur l'API pour une organisation en suivant les étapes ci-dessus dans Afficher les informations sur l'API pour une organisation.
- Filtrer les applications et les utilisateurs affichés dans le tableau « Acteurs ».
- Pour filtrer par nom, saisissez les premières lettres du nom dans le champ de recherche situé au-dessus du tableau « Acteurs ». Ensuite, appuyez sur Entrée.
- Pour filtrer par type d'acteur (application ou utilisateur), choisissez une option dans le menu déroulant Type en haut à droite du tableau « Acteurs ».
- Pour filtrer par type de demande (toutes ou à taux primaire limité), choisissez une option dans le menu déroulant Requêtes en haut à droite du tableau « Acteurs ».
Visualisation des informations sur l'API pour une application ou un utilisateur spécifique au sein d'une organisation
- Tout d'abord, affichez les informations sur l'API pour une organisation en suivant les étapes ci-dessus dans Afficher les informations sur l'API pour une organisation.
- Si vous le souhaitez, vous pouvez sélectionner une application dans le tableau « Acteurs » pour afficher l'activité de son API REST et toute limitation du taux primaire. La vue résultante sera spécifique à l'application sélectionnée et affichera les points d'extrémité de l'API auxquels elle a accédé.
- Si vous le souhaitez, vous pouvez sélectionner un utilisateur dans le tableau « Acteurs » pour afficher son activité REST API personnelle. La vue résultante sera spécifique à l'utilisateur sélectionné et affichera l'activité API de son personal access tokens et les requêtes effectuées par OAuth apps en son nom. Les deux contribuent à la limite du taux primaire personnel d'un utilisateur. Pour plus d'informations sur les limites de taux primaires pour les utilisateurs, et OAuth apps qui agissent en leur nom, consultez Limites de débit pour l'API REST.
- En option, dans la vue spécifique à l'utilisateur, cliquez sur une personal access token ou OAuth app pour afficher son activité API REST réalisée au nom de l'utilisateur.