Wyświetlasz dokumentację Apigee Edge.
Przejdź do
dokumentacji Apigee X. info
Ścieżka podstawowa platformy API:
https://api.enterprise.apigee.com/v1/o/{org_name}
Ścieżka zasobu API: /environments/{env_name}/stats/{dimension_name}
Opis: użyj metody GET, aby pobrać dane dla wymiaru.
| Czasownik: | GET |
| Uwierzytelnianie: | Uwierzytelnianie podstawowe |
| Typy multimediów: |
application/json
|
Omówienie: raport jest generowany za pomocą żądania GET do zasobu API
/stats
któremu towarzyszą:
- opcjonalny parametr URI, który określa wymiar raportu. Apigee definiuje zestaw wymiarów i wstępnie agreguje zestaw danych w odniesieniu do tych wymiarów. Jeśli nie zdefiniujesz wymiaru (tzn. jeśli parametr URI jest pusty), raport zostanie wygenerowany dla wszystkich interfejsów API w określonym środowisku.
- zestaw parametrów zapytania, które określają dane, zakres czasu, przedział czasu oraz aspekty filtrowania i szczegółowego analizowania raportu.
dimension_name: parametr URI, który określa encję, dla której należy pobrać dane platformy API. Apigee definiuje zestaw wymiarów, których można używać w
raportach. Obsługiwane wymiary:
/stats/apis: proxy interfejsów API w organizacji na platformie API/stats/apiproducts: produkty API zdefiniowane w organizacji/stats/apps: nazwa aplikacji dewelopera, która wysyła żądanie do Twojego interfejsu API/stats/client_ip: adresy IP aplikacji wysyłających żądania do interfejsów API na platformie API/stats/developer_email: adres e-mail dewelopera zarejestrowanego w organizacji na platformie API/stats/developer_app: nazwa aplikacji dewelopera, która wysyła żądanie do Twojego interfejsu API/stats/devs:unikalny identyfikator dewelopera wygenerowany przez Edge zarejestrowany w organizacji na platformie API/stats/access_token: token dostępu OAuth użytkownika końcowego aplikacji
Filtry można stosować do zasobów niestandardowych. Zasoby niestandardowe to:
| Symbol | Operacja |
|---|---|
in |
do uwzględniania na liście |
notin |
do wykluczania z listy |
eq |
= |
ne |
!= lub |
gt |
> |
lt |
|
ge |
>= |
le |
| Opis | Struktura zapytania filtra |
|---|---|
| Statystyki proxy interfejsów API o nazwach api1 lub api2 | filter=(apiproxy in 'api1','api2') |
| Statystyki wszystkich proxy interfejsów API z wyjątkiem api1 i api2 | filter=(apiproxy notin 'ap1','api2') |
| Statystyki, w których nie ma błędów | filter=(iserror eq 0) |
| Statystyki, w których nie ma komunikatów o błędach lub nazwa 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 (nazwa proxy interfejsu API 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 | Wymagany? |
|---|---|---|---|
| wybierz | Określa dane, które mają być agregowane w raporcie. Obsługiwane dane to message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size, end_point_response_time | Nie dotyczy | Tak |
| timeRange | Czas rozpoczęcia i zakończenia żądanego przedziału. Format daty to MM/DD/RRRR HH: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 | second, minute, hour, day, week, month, quarter, year, decade, century, millennium | Nie dotyczy | Tak |
| sortby | Jeśli określono co najmniej 2 wartości select, za pomocą parametru „sortby” można określić, która z nich ma być używana do sortowania wyników: message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size, end_point_response_time. | Nie dotyczy | Nie |
| sortuj | Obsługiwane zakresy sortowania to DESC i ASC. | Nie dotyczy | Nie |
| topk | Pobierz „k” najlepszych wyników, np. aby zwrócić 5 najlepszych wyników, użyj „topk=5” . | Nie dotyczy | Nie |
| filtr | Umożliwia szczegółowe analizowanie określonych 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ć paginację wyników. Aby na przykład wyświetlić wyniki 11-20, ustaw limit na „10” i przesunięcie na „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 są zbierane statystyki (obsługuje symbol wieloznaczny * do zbierania statystyk w różnych środowiskach) |
| 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 |