Gérer les collections à l'aide de l'API

Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X.
info

Les collections vous permettent de regrouper des proxys API, des cibles ou des applications de développement et de définir des valeurs de seuil appropriées pour tous les membres du groupe afin de diagnostiquer les problèmes plus rapidement.

Les sections suivantes décrivent comment gérer les collections à l'aide de l'API.

Pour en savoir plus sur l'API de collections, consultez API de collections.

Créer des collections à l'aide de l'API

Créez une collection de serveurs proxy d'API en envoyant une requête POST à la ressource suivante: https://apimonitoring.enterprise.apigee.com/collections

L'exemple suivant montre comment créer une collection.

curl 'https://apimonitoring.enterprise.apigee.com/collections' \
  -X POST \
  -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
     "organization":"myorg",
     "name":"My Collection",
     "description":"My collection for critical APIs",
     "environment": "prod",
     "type": "proxy",
     "members":["proxy1", "proxy2"]
    }'

Définissez $ACCESS_TOKEN sur votre jeton d'accès OAuth 2.0, comme décrit dans la section Obtenir un jeton d'accès OAuth 2.0.

Pour plus d'informations sur les options cURL utilisées dans cet exemple, consultez la page Utiliser cURL.

Vous pouvez spécifier la valeur type sur proxy, target ou developerApp. Par exemple, pour créer une collection d'applications de développeur:

curl 'https://apimonitoring.enterprise.apigee.com/collections' \
  -X POST \
  -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json"\
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
     "organization":"myorg",
     "name":"My Dev App Collection",
     "description":"My collection for critical apps",
     "environment": "prod",
     "type": "developerApp",
     "members":["app1", "app2"]
    }'

Afficher toutes les collections à l'aide de l'API

Affichez toutes les alertes et notifications en envoyant une demande GET à la ressource suivante: https://apimonitoring.enterprise.apigee.com/collections

Vous devez transmettre le nom de votre organisation à l'aide du paramètre de requête org.

Exemple :

curl 'https://apimonitoring.enterprise.apigee.com/collections?org=myorg' 
  -X GET
  -H 'Accept: application/json, text/plain, */*' 
  -H "Authorization: Bearer $ACCESS_TOKEN"    

Voici un exemple de réponse :

[{
     "uuid":"1234abcd",
     "organization":"myorg",
     "environment": "prod",
     "name":"My Collection",
     "type": "proxy",
     "members":["proxy1", "proxy2"],
     "description":"My collection for critical APIs",
     "updatedAt":"2018-07-13T16:25:15Z",
     "updatedBy":"joe@acme.com"
}]

Définissez $ACCESS_TOKEN sur votre jeton d'accès OAuth 2.0, comme décrit dans la section Obtenir un jeton d'accès OAuth 2.0.

Pour plus d'informations sur les options cURL utilisées dans cet exemple, consultez la page Utiliser cURL.

Ajoutez les uuid de la collection à la ressource /collections pour afficher la collection spécifique:

curl 'https://apimonitoring.enterprise.apigee.com/collections/1234abcd?org=myorg'
  -X GET
  -H 'Accept: application/json, text/plain, */*' 
  -H "Authorization: Bearer $ACCESS_TOKEN"