Stai visualizzando la documentazione di Apigee Edge.
Consulta la
documentazione di Apigee X. info
Percorso di base della piattaforma API:
https://api.enterprise.apigee.com/v1/o/{org_name}
Percorso della risorsa API: /environments/{env_name}/stats/{dimension_name}
Descrizione: utilizza il metodo GET per recuperare le metriche per una dimensione
| Verbo: | GET |
| Autentica: | Autenticazione di base |
| Tipi di contenuti multimediali: |
application/json
|
Panoramica: un report viene generato utilizzando una richiesta GET sulla risorsa API
/stats
accompagnata da:
- Un parametro URI facoltativo che definisce la dimensione per il report. Apigee definisce un insieme di dimensioni e pre-aggrega un insieme di metriche in base a queste 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 aspetti di filtro/drill-down del report.
dimension_name: un parametro URI che definisce l'entità per la quale 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 per sviluppatori che effettua la richiesta alla tua 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 per sviluppatori che effettua la richiesta alla tua API/stats/devs:l'ID sviluppatore univoco generato da Edge registrato in un organizzazione sulla piattaforma API/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 nell'elenco |
notin |
per l'esclusione dall'elenco |
eq |
= |
ne |
!= o |
gt |
> |
lt |
|
ge |
>= |
le |
| Descrizione | Struttura della query di filtro |
|---|---|
| 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 in cui non sono presenti 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 in cui (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') |
Richiesta di esempio:
$ 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 | Obbligatorio? |
|---|---|---|---|
| seleziona | Indica la metrica da aggregare 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/D | Sì |
| timeRange | L'ora di inizio e 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 è di 6 mesi | N/D | Sì |
| timeUnit | secondo, minuto, ora, giorno, settimana, mese, trimestre, anno, decennio, secolo, millennio | N/D | Sì |
| sortby | Quando vengono specificati due o più valori di selezione, "sortby" può essere utilizzato per specificare la selezione utilizzata per ordinare i risultati: message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size, end_point_response_time | N/D | No |
| sort | Gli ambiti di ordinamento supportati sono DESC o ASC | N/D | No |
| topk | Prendi i "k" risultati migliori dai risultati, ad esempio, per restituire i 5 risultati migliori "topk=5". | N/D | No |
| filter | Consente di eseguire il drill-down su valori di dimensioni specifici | N/D | No |
| limit | Imposta il limite per il numero di voci restituite dall'API | N/D | No |
| offset | Utilizza l'offset con il limite per attivare la paginazione dei risultati. Ad esempio, per visualizzare i risultati da 11 a 20, imposta il limite su "10" e l'offset su "10". | N/D | 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" : {
}
}| 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 tra ambienti) |
| metriche | I valori restituiti per la dimensione specificata |
| dimensioni | La dimensione definita per la misurazione: in questo esempio api_name. |
| metriche | Metriche per il report |