Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация
Базовый путь платформы API: https://api.enterprise.apigee.com/v1/o/{org_name}
Путь к ресурсу API: /environments/{env_name}/stats/{dimension_name}
Описание. Используйте метод GET для получения показателей для измерения.
| Глагол: | ПОЛУЧАТЬ |
| Автор: | Базовая аутентификация |
| Типы носителей: | приложение/json |
Обзор. Отчет создается с помощью запроса GET к ресурсу API
/stats , сопровождаемого:- Необязательный параметр URI, определяющий измерение отчета. Apigee определяет набор измерений и предварительно агрегирует набор метрик по этим измерениям. Если измерение не определено (т. е. если параметр URI пуст), то отчет создается для всех API, присутствующих в указанной среде.
- Набор параметров запроса, которые определяют метрики, временной диапазон, временной интервал и аспекты фильтрации/детализации отчета.
dimension_name : параметр URI, определяющий объект, для которого должны быть получены метрики платформы API. Apigee определяет набор измерений, которые можно использовать в отчетах. Поддерживаемые размеры включают:
-
/stats/apis: прокси-серверы API в организации на платформе API. -
/stats/apiproducts: продукты API, определенные в организации. -
/stats/apps: имя приложения разработчика, отправляющего запрос к вашему API. -
/stats/client_ip: IP-адреса приложений, отправляющих запросы к API на платформе API. -
/stats/developer_email: адрес электронной почты разработчика, зарегистрированного в организации на платформе API. -
/stats/developer_app: имя приложения разработчика, отправляющего запрос к вашему API. -
/stats/devs: уникальный идентификатор разработчика, сгенерированный Edge, зарегистрированный в организации на платформе API. -
/stats/access_token: токен доступа OAuth конечного пользователя приложения.
Фильтры можно применять к пользовательским ресурсам. Пользовательские ресурсы:
| Символ | Операция |
|---|---|
in | для включения в список |
notin | для исключения из списка |
eq | = |
ne | != или |
gt | > |
lt | |
ge | >= |
le |
| Описание | Структура запроса фильтра |
|---|---|
| Статистика для прокси-серверов API с именами api1 или api2 | filter=(apiproxy in 'api1','api2') |
| Статистика для всех прокси API, кроме api1 и api2 | filter=(apiproxy notin 'ap1','api2') |
| Статистика, где нет ошибок | filter=(iserror eq 0) |
| Статистика, в которой нет сообщений об ошибках или имя прокси-сервера API — api1 или api2. | filter=(iserror eq 1) or (apiproxy in 'api1','api2') |
| Статистика, где (код ответа — 201 или 301) и (есть ошибки) или (имя прокси-сервера API — api1 или api2) | filter=(responsecode le 201 or responsecode eq 301) and (iserror eq 1) or (apiproxy in 'api1','api2') |
Образец запроса:
$ 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
| Имя | Описание | По умолчанию | Необходимый? |
|---|---|---|---|
| выбирать | Определяет метрику, которая будет агрегирована для отчета. Поддерживаемые метрики: message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size, end_point_response_time. | Н/Д | Да |
| диапазон времени | Время начала и окончания желаемого интервала. Формат даты: ММ/ДД/ГГГГ ЧЧ:ММ. Например, 01.01.2013%2000:00~02.01.2013%2000:00. Максимальный диапазон времени составляет 6 месяцев. | Н/Д | Да |
| Единица времени | секунда, минута, час, день, неделя, месяц, квартал, год, десятилетие, век, тысячелетие | Н/Д | Да |
| Сортировать по | Если указаны два или более значений выбора, можно использовать сортировку для указания выбора, используемого для сортировки результатов: message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size, end_point_response_time | Н/Д | Нет |
| сортировать | Поддерживаемые области сортировки: DESC или ASC. | Н/Д | Нет |
| топк | Возьмите, например, результаты «top k» из результатов, чтобы вернуть 5 лучших результатов «topk=5». | Н/Д | Нет |
| фильтр | Позволяет детализировать конкретные значения измерения. | Н/Д | Нет |
| предел | Установите ограничение на количество записей, возвращаемых API. | Н/Д | Нет |
| компенсировать | Используйте смещение с ограничением, чтобы включить разбивку результатов на страницы. Например, чтобы отобразить результаты 11–20, установите предел на «10» и смещение на «10». | Н/Д | Нет |
{
"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" : {
}
}
Элементы полезной нагрузки ответа: | Имя | Описание |
|---|---|
| метаданные | Метаданные, связанные с отчетом |
| окружающая среда | Среды в организации, в которых собирается статистика (поддерживается подстановочный знак * для сбора статистики между средами) |
| метрики | Значения, возвращаемые для указанного измерения |
| размеры | Измерение, определенное для измерения: в этом примере имя_api. |
| метрики | Метрики для отчета |