Zarządzanie kolekcjami przy użyciu interfejsu API

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X.
info

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

W sekcjach poniżej opisano, jak zarządzać kolekcjami za pomocą interfejsu API.

Więcej informacji o interfejsie API kolekcji znajdziesz w dokumentacji interfejsu API kolekcji.

Tworzenie kolekcji za pomocą interfejsu API

Aby utworzyć kolekcję serwerów proxy interfejsu API, wyślij żądanie POST do tego zasobu: https://apimonitoring.enterprise.apigee.com/collections

Poniższy przykład pokazuje, 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 $ACCESS_TOKEN na token dostępu OAuth 2.0 zgodnie z opisem w artykule Uzyskiwanie tokena dostępu OAuth 2.0.

Informacje o opcjach cURL używanych w tym przykładzie znajdziesz w artykule Korzystanie z cURL.

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

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 za pomocą interfejsu API

Aby wyświetlić wszystkie alerty i powiadomienia, wyślij żądanie GET do tego zasobu: https://apimonitoring.enterprise.apigee.com/collections

Musisz przekazać nazwę 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"    

Poniżej znajdziesz przykład odpowiedzi:

[{
     "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 $ACCESS_TOKEN na token dostępu OAuth 2.0 zgodnie z opisem w artykule Uzyskiwanie tokena dostępu OAuth 2.0.

Informacje o opcjach cURL używanych w tym przykładzie znajdziesz w artykule Korzystanie z cURL.

Aby wyświetlić konkretną kolekcję, dołącz jej uuid do zasobu /collections:

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