Przeglądasz dokumentację Apigee Edge.
Przejdź do
Dokumentacja Apigee X. informacje.
Ścieżka podstawowa platformy interfejsu API:
https://api.enterprise.apigee.com/v1/o/{org_name}
Ścieżka zasobu API: /environments/{env_name}/stats/{dimension_name}
Opis: pobieranie danych o wymiarze za pomocą metody GET
| Czasownik: | POBIERZ |
| Uwierzytelnianie: | Podstawowe uwierzytelnianie |
| Typy multimediów: |
application/json
|
Omówienie: raport jest generowany przy użyciu żądania GET w interfejsie API
/stats.
oraz:
- Opcjonalny parametr URI określający wymiar na potrzeby raportu. Apigee definiuje zbiór wymiarów, powoduje wstępne zagregowanie zbioru danych w odniesieniu do tych wymiarów. Jeśli żaden wymiar nie jest (tj. jeśli parametr URI jest pusty), raport jest generowany dla wszystkich interfejsów API w określonym środowisku.
- zbiór parametrów zapytania definiujących dane, zakres czasowy, przedział czasu oraz aby przeanalizować jego aspekty.
dimension_name: parametr URI określający jednostkę, dla której interfejs API
Należy pobrać wskaźniki platformy. Apigee definiuje zbiór wymiarów, których można używać
raportów. Obsługiwane wymiary:
/stats/apis: serwery proxy interfejsów API w organizacji na platformie API/stats/apiproducts: usługi API zdefiniowane w organizacji/stats/apps: nazwa aplikacji dewelopera wysyłającej żądanie do interfejsu API./stats/client_ip: adresy IP aplikacji wysyłających żądania do interfejsów API. Platforma/stats/developer_email: adres e-mail dewelopera zarejestrowanego w organizacji korzystających z platformy API/stats/developer_app: nazwa aplikacji dewelopera wysyłającej żądanie Twój interfejs API/stats/devs:unikalny identyfikator dewelopera wygenerowany przez Edge i zarejestrowany w organizacji korzystających z platformy API/stats/access_token: token dostępu OAuth użytkownika aplikacji
Filtry można stosować do zasobów niestandardowych. Zasoby niestandardowe to:
| Symbol | Operacja |
|---|---|
in |
w celu uwzględnienia na liście |
notin |
do wykluczenia z listy |
eq |
= |
ne |
!= lub |
gt |
> |
lt |
|
ge |
>= |
le |
| Opis | Filtruj strukturę zapytania |
|---|---|
| Statystyki serwerów proxy interfejsu API o nazwach api1 lub api2 | filter=(apiproxy in 'api1','api2') |
| Statystyki wszystkich serwerów proxy interfejsu API oprócz api1 i api2 | filter=(apiproxy notin 'ap1','api2') |
| Statystyki bez błędów | filter=(iserror eq 0) |
| Statystyki, w których nie ma komunikatów o błędach lub nazwa serwera proxy interfejsu API to api1 lub api2 | filter=(iserror eq 1) or (apiproxy in 'api1','api2') |
| statystyki, w których (kod odpowiedzi to 201 lub 301) i (występują błędy) lub (serwer proxy interfejsu API); nazwa to api1 lub api2) | filter=(responsecode le 201 or responsecode eq 301) and (iserror eq 1) or
(apiproxy in 'api1','api2') |
Przykładowe żądanie:
$ curl -X GET -H "Accept:application/json" \
https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/stats/{dimension_name}?"select={metric_name}&timeRange=1/1/2013%2000:00~1/2/2013%2000:00&timeUnit=hour&sortby={metric_name}&sort=DESC&filter=(apiproxy%20in%20'weather','news')" \
-u myname:mypass
| Nazwa | Opis | Domyślny | Wymagana? |
|---|---|---|---|
| wybierz | Wskazuje dane, które mają być agregowane na potrzeby raportu. Obsługiwane dane to: message_count, error_count, total_response_time, max_response_time, min_response_time, data_Exchange_size oraz end_point_response_time | Nie dotyczy | Tak |
| timeRange | Godzina rozpoczęcia i zakończenia wybranego interwału. Format daty to DD.MM.RRRR GG:MM. Na przykład 1/1/2013%2000:00~1/2/2013%2000:00. Maksymalny zakres czasu to 6 miesięcy | Nie dotyczy | Tak |
| timeUnit | druga, minuta, godzina, dzień, tydzień, miesiąc, kwartał, rok, dekada, wiek, tysiąclecia | Nie dotyczy | Tak |
| Sortuj | Jeśli określone są co najmniej 2 wartości wyboru, funkcja „sortby” może służyć do określania wybierz używane do sortowania wyników: message_count, error_count, total_response_time, max_response_time, min_response_time, data_Exchange_size oraz end_point_response_time | Nie dotyczy | Nie |
| sortuj | Obsługiwane zakresy sortowania to DESC lub ASC | Nie dotyczy | Nie |
| Topk | Wybierz „pierwsze k” wyników z wyników (np. w celu zwrócenia 5 pierwszych wyników) „topk=5”. | Nie dotyczy | Nie |
| filtr | Umożliwia analizę konkretnych wartości wymiarów | Nie dotyczy | Nie |
| limit | Ustaw limit liczby wpisów zwracanych przez interfejs API | Nie dotyczy | Nie |
| odliczyć | Użyj przesunięcia z limitem, aby włączyć podział wyników na strony. Aby na przykład wyświetlić wyniki 11–20, ustaw limit na „10” i przesunięcie do wartości „10”. | Nie dotyczy | Nie |
{
"environments" : [ {
"dimensions" : [ {
"metrics" : [
{
"name" : "message_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "1.0"
} ]
} ,
{
"name" : "error_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "0.0"
} ]
}
],
"name" : "api1"
},
{
"metrics" : [
{
"name" : "message_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "1.0"
} ]
},
{
"name" : "error_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "0.0"
} ]
}
],
"name" : "api2"
}
],
"name" : "test"
}
],
"metaData" : {
}
}| Nazwa | Opis |
|---|---|
| metadane | Metadane powiązane z raportem |
| środowiska | Środowiska w organizacji, w których zbierane są statystyki (obsługa symboli wieloznacznych) * do gromadzenia statystyk dotyczących różnych środowisk). |
| wskaźniki | Wartości zwracane dla określonego wymiaru |
| wymiary | Wymiar zdefiniowany na potrzeby pomiaru: w tym przykładzie api_name. |
| wskaźniki | Dane w raporcie |