Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione
Documentazione di Apigee X. Informazioni
Percorso di base della 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: | SCARICA |
| Autorizzazione: | Autorizzazione di base |
| Tipi di contenuti multimediali: |
application/json
|
Panoramica: viene generato un report utilizzando una richiesta GET sull'API
/stats.
risorsa, accompagnata da:
- Un parametro URI facoltativo che definisce la dimensione del report. Apigee definisce un insieme di dimensioni pre-aggrega un insieme di metriche in base a quelle dimensioni. Se nessuna dimensione è (ad es.se il parametro URI è vuoto), viene generato un report per tutte le API. presente nell'ambiente specificato.
- Un insieme di parametri di query che definiscono le metriche, l'intervallo di tempo, l'intervallo di tempo di filtrare o visualizzare in dettaglio aspetti del report.
dimension_name: un parametro URI che definisce l'entità per la quale l'API
Le metriche della piattaforma devono essere recuperate. Apigee definisce un insieme di dimensioni che possono essere utilizzate
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 sull'API Piattaforma/stats/developer_email: l'indirizzo email di uno sviluppatore registrato in un sulla piattaforma API/stats/developer_app: il nome dell'app sviluppatore che invia la richiesta a la tua API/stats/devs:l'ID sviluppatore univoco generato da Edge registrato in un 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 degli elenchi |
notin |
per l'esclusione dell'elenco |
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 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 dove (codice di risposta è 201 o 301) e (sono presenti errori) o (proxy API) il nome è 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 | 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 è 6 mesi | N/D | Sì |
| timeUnit | secondo, minuto, ora, giorno, settimana, mese, trimestre, anno, decennio, secolo, millennio | N/D | Sì |
| ordinare | Quando vengono specificati due o più valori, "ordinaby" può essere utilizzato per specificare seleziona 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 |
| ordinare | Gli ambiti di ordinamento supportati sono DESC o ASC | N/D | No |
| Topk | Prendi "top k" dai risultati, ad esempio, per restituire i primi 5 risultati. "topk=5". | N/D | No |
| filtro | Attiva la visualizzazione in dettaglio di valori specifici delle dimensioni | N/D | No |
| limite | Imposta il limite per il numero di voci restituite dall'API | N/D | 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 sfalsato a "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 |