Stai visualizzando la documentazione di Apigee Edge.
Vai alla
documentazione di Apigee X. informazioni
Percorso base piattaforma API:
https://api.enterprise.apigee.com/v1/o/{org_name}
Percorso risorsa API: /environments/{env_name}/stats/{dimension_name}
Descrizione: utilizza il metodo Get per recuperare le metriche per una dimensione
| Verbo: | GET |
| Autorizzazione: | Autorizzazione di base |
| Tipi di contenuti multimediali: |
application/json
|
Panoramica: viene generato un report utilizzando una richiesta GET sulla risorsa API
/stats, accompagnato da:
- Un parametro URI facoltativo che definisce la dimensione del report. Apigee definisce un insieme di dimensioni e preaggrega un insieme di metriche in base a tali dimensioni. Se non viene definita alcuna dimensione, ovvero se il parametro URI è vuoto, viene generato un report per tutte le API presenti nell'ambiente specificato.
- Un insieme di parametri di query che definiscono le metriche, l'intervallo di tempo, l'intervallo di tempo e gli aspetti di filtro/visualizzazione in dettaglio del report.
dimension_name: un parametro URI che definisce l'entità per cui devono essere recuperate le metriche della piattaforma API. Apigee definisce un insieme di dimensioni che possono essere utilizzate nei report. Le dimensioni supportate includono:
/stats/apis: proxy API in un'organizzazione sulla piattaforma API/stats/apiproducts: prodotti API definiti in un'organizzazione/stats/apps: il nome dell'app sviluppatore che effettua la richiesta all'API./stats/client_ip: indirizzi IP delle app che effettuano la richiesta alle API sulla piattaforma API/stats/developer_email: l'indirizzo email di uno sviluppatore registrato in un'organizzazione sulla piattaforma API/stats/developer_app: il nome dell'app sviluppatore che effettua la richiesta all'API/stats/devs:l'ID sviluppatore univoco generato da Edge registrato in un'organizzazione su API Platform/stats/access_token: il token di accesso OAuth dell'utente finale dell'app
I filtri possono essere applicati alle risorse personalizzate. Le risorse personalizzate sono:
| Simbolo | Operazione |
|---|---|
in |
per l'inclusione dell'elenco |
notin |
per l'esclusione di elenchi |
eq |
= |
ne |
!= o |
gt |
> |
lt |
|
ge |
>= |
le |
| Descrizione | Filtra struttura delle query |
|---|---|
| Statistiche per i proxy API denominati api1 o api2 | filter=(apiproxy in 'api1','api2') |
| Statistiche per tutti i proxy API tranne api1 e api2 | filter=(apiproxy notin 'ap1','api2') |
| Statistiche senza errori | filter=(iserror eq 0) |
| Statistiche in cui non sono presenti messaggi di errore o il nome del proxy API è api1 o api2 | filter=(iserror eq 1) or (apiproxy in 'api1','api2') |
| Statistiche dove (il codice di risposta è 201 o 301) e (sono presenti errori) o (il nome del proxy API è api1 o api2) | filter=(responsecode le 201 or responsecode eq 301) and (iserror eq 1) or
(apiproxy in 'api1','api2') |
Esempio di richiesta:
$ 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
| Nome | Descrizione | Predefinito | Campo obbligatorio? |
|---|---|---|---|
| seleziona | Specifica la metrica da aggregata per il report. Le metriche supportate sono message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size, end_point_response_time | N/A | Sì |
| timeRange | L'ora di inizio e l'ora di fine dell'intervallo desiderato. Il formato della data è MM/GG/AAAA HH:MM. Ad esempio 1/1/2013%2000:00~1/2/2013%2000:00. L'intervallo di tempo massimo è 6 mesi | N/A | Sì |
| timeUnit | secondo, minuto, ora, giorno, settimana, mese, trimestre, anno, decennio, secolo, millennio | N/A | Sì |
| sortby | Quando sono specificati due o più valori selezionati, è possibile utilizzare "sortby" per specificare la selezione utilizzata per l'ordinamento dei risultati: message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size, end_point_response_time | N/A | No |
| ordinare | Gli ambiti di ordinamento supportati sono DESC o ASC | N/A | No |
| Topk | Prendi ad esempio i risultati di "top-k" tra i risultati per restituire i primi 5 risultati "topk=5". | N/A | No |
| filter | Consente di visualizzare in dettaglio valori specifici delle dimensioni | N/A | No |
| limite | Imposta il limite per il numero di voci restituite dall'API | N/A | No |
| offset | Utilizza l'offset con limite per abilitare l'impaginazione dei risultati. Ad esempio, per visualizzare i risultati 11-20, imposta il limite su "10" e l'offset su "10". | N/A | No |
{
"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" : {
}
}
Elementi payload di risposta:
| Nome | Descrizione |
|---|---|
| metadati | Metadati associati al report |
| environments | Ambienti dell'organizzazione in cui vengono raccolte le statistiche (supporta il carattere jolly * per la raccolta di statistiche cross-environment) |
| metrics | I valori restituiti per la dimensione specificata |
| dimensioni | La dimensione definita per la misurazione: in questo esempio api_name. |
| metrics | Metriche per il report |