Estás viendo la documentación de Apigee Edge.
Ir a la
documentación de Apigee X. info
Ruta de acceso base de la plataforma de API:
https://api.enterprise.apigee.com/v1/o/{org_name}
Ruta de acceso del recurso de la API: /environments/{env_name}/stats/{dimension_name}
Descripción: Usa el método GET para recuperar métricas de una dimensión.
| Verbo: | GET |
| Autenticación: | Autenticación básica |
| Tipos de medios: |
application/json
|
Descripción general: Se genera un informe con una solicitud GET en el recurso de la API
/stats
acompañado de lo siguiente:
- Un parámetro URI opcional que define la dimensión del informe. Apigee define un conjunto de dimensiones y un conjunto de métricas preagregadas en función de esas dimensiones. Si no se define ninguna dimensión (es decir, si el parámetro URI está vacío), se genera un informe para todas las APIs presentes en el entorno especificado.
- Un conjunto de parámetros de consulta que definen las métricas, el intervalo de tiempo, el intervalo de tiempo y aspectos de filtro o desglose del informe.
dimension_name: Un parámetro URI que define la entidad para la que se deben recuperar las métricas de la plataforma de API. Apigee define un conjunto de dimensiones que se pueden usar en
informes. Entre las dimensiones admitidas, se incluyen las siguientes:
/stats/apis: Proxies de API en una organización en la plataforma de API/stats/apiproducts: Productos de API definidos en una organización/stats/apps: El nombre de la app para desarrolladores que realiza la solicitud a tu API/stats/client_ip: Direcciones IP de las apps que realizan la solicitud a las APIs en la plataforma de API/stats/developer_email: La dirección de correo electrónico de un desarrollador registrado en una organización en la plataforma de API/stats/developer_app: El nombre de la app para desarrolladores que realiza la solicitud a tu API/stats/devs:El ID de desarrollador único generado por Edge registrado en una organización en la plataforma de API/stats/access_token: El token de acceso de OAuth del usuario final de la app
Los filtros se pueden aplicar a recursos personalizados. Los recursos personalizados son los siguientes:
| Símbolo | Operación |
|---|---|
in |
para la inclusión en la lista |
notin |
para la exclusión de la lista |
eq |
= |
ne |
!= o |
gt |
> |
lt |
|
ge |
>= |
le |
| Descripción | Estructura de la consulta de filtro |
|---|---|
| Estadísticas de los proxies de API denominados api1 o api2 | filter=(apiproxy in 'api1','api2') |
| Estadísticas de todos los proxies de API, excepto api1 y api2 | filter=(apiproxy notin 'ap1','api2') |
| Estadísticas en las que no hay errores | filter=(iserror eq 0) |
| Estadísticas en las que no hay mensajes de error o el nombre del proxy de API es api1 o api2 | filter=(iserror eq 1) or (apiproxy in 'api1','api2') |
| Estadísticas en las que (el código de respuesta es 201 o 301) y (hay errores) o (el nombre del proxy de API es api1 o api2) | filter=(responsecode le 201 or responsecode eq 301) and (iserror eq 1) or
(apiproxy in 'api1','api2') |
Solicitud de ejemplo:
$ 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
| Nombre | Descripción | Predeterminado | ¿Obligatorio? |
|---|---|---|---|
| seleccionar | Designa la métrica que se agregará para el informe. Las métricas admitidas son message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size y end_point_response_time. | N/A | Sí |
| timeRange | La hora de inicio y finalización del intervalo deseado. El formato de fecha es MM/DD/AAAA HH:MM. Por ejemplo, 1/1/2013%2000:00~1/2/2013%2000:00. El intervalo de tiempo máximo es de 6 meses. | N/A | Sí |
| timeUnit | segundo, minuto, hora, día, semana, mes, trimestre, año, década, siglo, milenio | N/A | Sí |
| Ordenar por: | Cuando se especifican dos o más valores de selección, se puede usar “ordenar por” para especificar la selección que se usa para ordenar los resultados: message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size y end_point_response_time. | N/A | No |
| sort | Los alcances de ordenamiento admitidos son DESC o ASC. | N/A | No |
| Top-K | Toma los resultados “k principales” de los resultados, por ejemplo, para mostrar los 5 resultados principales “topk=5”. | N/A | No |
| filter | Permite el desglose de valores de dimensión específicos. | N/A | No |
| límite | Establece el límite para la cantidad de entradas que muestra la API. | N/A | No |
| offset | Usa offset con limit para habilitar la paginación de los resultados. Por ejemplo, para mostrar los resultados 11 a 20, establece el límite en “10” y el desplazamiento en “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" : {
}
}| Nombre | Descripción |
|---|---|
| metadatos | Metadatos asociados con el informe |
| entornos | Entornos en la organización en la que se recopilan las estadísticas (admite el comodín * para la recopilación de estadísticas entre entornos) |
| métricas | Los valores que se muestran para la dimensión especificada |
| dimensiones | La dimensión definida para la medición: en este ejemplo, api_name. |
| métricas | Métricas del informe |