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, celów lub aplikacji dewelopera oraz konfigurowanie odpowiednich wartości progowych dla wszystkich członków grupy, aby szybciej diagnozować problemy.

W kolejnych sekcjach opisaliśmy, jak zarządzać zbiorami za pomocą interfejsu API.

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

Tworzenie kolekcji za pomocą interfejsu API

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

W tym przykładzie pokazujemy, 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 wartość $ACCESS_TOKEN na token dostępu OAuth 2.0 zgodnie z opisem w sekcji Uzyskiwanie tokena dostępu OAuth 2.0.

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

Wartość type może być określona 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

Nazwa organizacji musi być przekazywana 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ł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 wartość $ACCESS_TOKEN na token dostępu OAuth 2.0 zgodnie z opisem w sekcji Uzyskiwanie tokena dostępu OAuth 2.0.

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

Aby wyświetlić konkretną kolekcję, dodaj do zasobu /collections identyfikator uuid tej kolekcji:

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