Instana API et les SDK

Modifier en ligne

Les API « Instana » vous permettent d'intégrer la plateforme de surveillance et d'observabilité « Instana » à vos applications.

Pour plus d'informations, consultez la documentation REST API Instana et la documentation GraphQL Instana.

Prérequis

Modifier en ligne

Avant de commencer, assurez-vous d'avoir des connaissances de base sur les API RESTful, les protocoles GraphQL, HTTP, et de disposer d'un compte Instana.

Génération d'un jeton « API » pour l'authentification

Modifier en ligne

Pour authentifier les requêtes adressées aux API d' Instana, vous devez disposer d'un jeton API. Suivez les étapes suivantes pour générer votre jeton « API » :

  1. Connectez-vous à votre compte Instana.
  2. Dans le menu de navigation de l'interface utilisateur d' Instana, cliquez sur « Paramètres ».
  3. Dans l'onglet « Sécurité et accès », dans la section « Contrôle d'accès », cliquez sur « Jetons API ».
  4. Saisissez un nom pour votre jeton et définissez les autorisations appropriées.
  5. Une fois le jeton « API » généré, copiez votre jeton « API » et conservez-le en lieu sûr pour une utilisation ultérieure.

soumission de demandes

Modifier en ligne

Les sites Instana, REST API, GraphQL et API utilisent des méthodes standard de HTTP. L' URL de base est unique à chaque instance d' Instana; elle est dérivée de votre tenant et de votre unité, et correspond à l' URL que vous utilisez pour accéder à l'interface utilisateur de Instana.

Utilisez votre jeton « API » pour authentifier chaque requête.

  • Adresse URL de base : https://<TENANT>-<UNIT>.instana.io/api
  • Autorisation : incluez votre jeton « API » dans l'en-tête Authorization en utilisant le Bearer schéma.
L'exemple suivant illustre une requête utilisant curl :
curl -X GET https://<TENANT>-<UNIT>.instana.io/api/<INSTANA_REST_API_ENDPOINT> \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"
Pour les demandes relatives à l' GraphQL, toutes les demandes doivent être adressées à une seule adresse e- URL :
POST https://<your-instana-host>/api/graphql

Remplacez <your-instana-host> par le nom d'hôte de votre tenant Instana (par exemple, my-company.instana.io).

Chaque requête est une requête de type « HTTPPOST » dont le corps de type « JSON » contient la requête que vous souhaitez exécuter.

Nœuds finaux d'API

Modifier en ligne

Un point de terminaison « API » est une adresse URL spécifique qui accepte les requêtes relatives à une opération particulière. Instana fournit des points de terminaison qui vous permettent d'interroger les données de surveillance, de configurer des alertes et de gérer des événements personnalisés.

Pour plus d'informations sur l'utilisation de REST API Instana et de chaque point de terminaison, y compris les paramètres de requête, les formats de réponse et des exemples de requêtes, consultez la documentation REST API Instana.

Les requêtes GraphQL possèdent un point d'accès unique : `api/graphql`. Pour plus d'informations sur les requêtes GraphQL, consultez la documentation GraphQL Instana.