Zarządzanie kolekcjami przy użyciu interfejsu API

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X.
Informacje

Kolekcje umożliwiają grupowanie serwerów proxy interfejsu API, celów lub aplikacji deweloperskich i konfigurowanie odpowiednich wartości progowych dla wszystkich członków grupy, co pozwala szybciej diagnozować problemy.

W kolejnych sekcjach opisano, jak zarządzać kolekcjami za pomocą interfejsu API.

Więcej informacji o interfejsie collections API znajdziesz w artykule na temat Collections API.

Tworzenie kolekcji przy użyciu interfejsu API

Utwórz kolekcję serwerów proxy interfejsu API, wysyłając żądanie POST do tego zasobu: https://apimonitoring.enterprise.apigee.com/collections

Z przykładu poniżej dowiesz się, jak utworzyć kolekcję.

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"]
    }'

Ustaw w $ACCESS_TOKEN token dostępu OAuth 2.0 zgodnie z opisem w artykule Uzyskiwanie tokena dostępu OAuth 2.0.

Informacje o opcjach cURL użytych w tym przykładzie znajdziesz w artykule Użycie cURL.

Możesz określić wartość type jako proxy, target lub developerApp. Aby na przykład utworzyć kolekcję aplikacji dla deweloperów:

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"]
    }'

Wyświetlanie wszystkich kolekcji przy użyciu interfejsu API

Wyświetl wszystkie alerty i powiadomienia, wysyłając żądanie GET do tego zasobu: https://apimonitoring.enterprise.apigee.com/collections

Musisz przekazać nazwę swojej organizacji za pomocą parametru zapytania org.

Na przykład:

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

Oto przykładowa odpowiedź:

[{
     "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"
}]

Ustaw w $ACCESS_TOKEN token dostępu OAuth 2.0 zgodnie z opisem w artykule Uzyskiwanie tokena dostępu OAuth 2.0.

Informacje o opcjach cURL użytych w tym przykładzie znajdziesz w artykule Użycie cURL.

Dołącz uuid kolekcji do zasobu /collections, aby wyświetlić konkretną kolekcję:

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