Estás viendo la documentación de Apigee Edge.
Ve a la
Documentación de Apigee X. información
Ruta base de la plataforma de API:
https://api.enterprise.apigee.com/v1/o/{org_name}
Ruta de acceso al 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: | OBTÉN |
| Autenticación: | Autenticación básica |
| Tipos de medios: |
application/json
|
Descripción general: Se genera un informe con una solicitud GET en la API de
/stats
recurso, acompañado de lo siguiente:
- Es un parámetro de URI opcional que define la dimensión del informe. Apigee define un conjunto de dimensiones a agrega previamente un conjunto de métricas en comparación con esas dimensiones. Si no se muestra ninguna dimensión, definido (es decir, si el parámetro de URI está vacío), se generará un informe para todas las APIs presente en el entorno especificado.
- Un conjunto de parámetros de consulta que define las métricas, el intervalo de tiempo, el intervalo de tiempo y los aspectos de filtrado/desglose del informe.
dimension_name: un parámetro de URI que define la entidad para la que la API
Se deben recuperar las métricas de la plataforma. 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 APIs/stats/apiproducts: Los productos de API definidos en una organización/stats/apps: Es el nombre de la app de desarrollador que realiza la solicitud a tu API./stats/client_ip: Direcciones IP de las apps que realizan la solicitud a las APIs en la API Plataforma/stats/developer_email: La dirección de correo electrónico de un desarrollador registrado en un organización en la plataforma de APIs/stats/developer_app: Es el nombre de la app del desarrollador que realiza la solicitud. tu API/stats/devs:El ID de desarrollador único generado por Edge registrado en un organización en la plataforma de APIs/stats/access_token: Es el token de acceso OAuth del usuario final de la app.
Se pueden aplicar filtros a recursos personalizados. Los recursos personalizados tienen las siguientes características:
| Símbolo | Operación |
|---|---|
in |
para la inclusión de listas |
notin |
para la exclusión de listas |
eq |
= |
ne |
!= o |
gt |
> |
lt |
|
ge |
>= |
le |
| Descripción | Filtra la estructura de la consulta |
|---|---|
| Estadísticas de los proxies de API llamados api1 o api2 | filter=(apiproxy in 'api1','api2') |
| Estadísticas para 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 la 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 (proxy de API) el nombre es api1 o api2) | filter=(responsecode le 201 or responsecode eq 301) and (iserror eq 1) or
(apiproxy in 'api1','api2') |
Solicitud de muestra:
$ 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 | Predeterminada | ¿Obligatorio? |
|---|---|---|---|
| select | 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, end_point_response_time | N/A | Sí |
| Intervalo de tiempo | La hora de inicio y finalización del intervalo deseado. El formato de la 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í |
| Unidad de tiempo | 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, “sortby” que se puede usar para especificar 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, end_point_response_time | N/A | No |
| ordenar | Los alcances de clasificación admitidos son DESC o ASC | N/A | No |
| Top-K | Tomar "top k" resultados de los resultados, por ejemplo, para devolver 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 el desplazamiento con límite para habilitar la paginación de los resultados. Por ejemplo, para mostrar resultados De 11 a 20, establecer el límite en “10” y el desplazamiento a “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 de la organización en los que se recopilan las estadísticas (admite los * 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 |