Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje
Ścieżka podstawowa platformy API:
https://api.enterprise.apigee.com/v1/o/{org_name}
Ścieżka zasobu interfejsu API: /environments/{env_name}/stats/{dimension_name}
Opis: pobieranie danych dla wymiaru za pomocą metody GET
| Czasownik: | GET |
| Uwierzytelnianie: | Podstawowe uwierzytelnianie |
| Rodzaje nośników: |
application/json
|
Omówienie: raport jest generowany za pomocą żądania GET dotyczącego zasobu interfejsu API
/stats, do którego dołączają te informacje:
- Opcjonalny parametr URI, który określa wymiar raportu. Apigee definiuje zestaw wymiarów, które wstępnie agregują zestaw danych według tych wymiarów. Jeśli nie określono żadnego wymiaru (tj. parametr URI jest pusty), zostanie wygenerowany raport dla wszystkich interfejsów API występujących w określonym środowisku.
- Zestaw parametrów zapytania, które definiują dane, zakres czasu i przedział czasu oraz aspekty filtrowania i analizy raportu.
dimension_name: parametr URI określający jednostkę, dla której mają być pobierane wskaźniki API Platform. Apigee definiuje zestaw wymiarów, których można używać w raportach. Obsługiwane wymiary:
/stats/apis: serwery proxy API w organizacji na platformie API/stats/apiproducts: usługi API zdefiniowane w organizacji./stats/apps: nazwa aplikacji dewelopera wysyłającej żą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 wysyłającej żądanie do interfejsu API/stats/devs:unikalny identyfikator dewelopera wygenerowany na brzegu sieci 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. Niestandardowe zasoby to:
| Symbol | Operacja |
|---|---|
in |
w celu dodania do listy |
notin |
do wykluczenia 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 dla wszystkich serwerów proxy interfejsów API oprócz api1 i api2 | filter=(apiproxy notin 'ap1','api2') |
| Statystyki bez błędów | filter=(iserror eq 0) |
| Statystyki, w przypadku 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 (nazwa serwera 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ślne | Wymagana? |
|---|---|---|---|
| wybierz | Wskazuje dane, które zostaną zagregowane na potrzeby raportu. Obsługiwane wskaźniki 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 | Czas rozpoczęcia i zakończenia wybranego interwału. Format daty to MM/DD/RRRR GG:MM. Na przykład 1/1/2013%2000:00~1/2/2013%2000:00. Maksymalny zakres czasowy to 6 miesięcy | Nie dotyczy | Tak |
| timeUnit | druga, minuta, godzina, dzień, tydzień, miesiąc, kwartał, rok, dekada, wiek, tysiąclecie | Nie dotyczy | Tak |
| Sortuj | Jeśli określono co najmniej 2 wartości wyboru, można użyć funkcji „sortby” do określenia opcji 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 | Na przykład użyjemy wyników „top k” z wyników, aby zwrócić 5 pierwszych wyników: „topk=5”. | Nie dotyczy | Nie |
| filter | Umożliwia analizowanie konkretnych wartości wymiarów | Nie dotyczy | Nie |
| limit | Ustaw limit liczby wpisów zwracanych przez interfejs API | Nie dotyczy | Nie |
| przesunięcie | Aby włączyć dzielenie wyników na strony, użyj przesunięcia z limitem. Aby na przykład wyświetlić wyniki od 11 do 20, ustaw limit na „10”, a 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" : {
}
}
Elementy ładunku odpowiedzi:
| Nazwa | Opis |
|---|---|
| metadane | Metadane powiązane z raportem |
| środowiska | Środowiska w organizacji, w której są zbierane statystyki (obsługa symboli wieloznacznych * przy zbieraniu statystyk z różnych środowisk) |
| metrics | Wartości zwracane dla określonego wymiaru |
| wymiary | Wymiar zdefiniowany na potrzeby pomiaru: w tym przykładzie: api_name. |
| metrics | Dane do raportu |