Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info
Базовый путь к 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') |
| Stats where (response code is either 201 or 301) and (there are errors) or (API proxy name is either api1 or 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 | Н/Д | Да |
| временной диапазон | Укажите время начала и окончания желаемого интервала. Формат даты: MM/DD/YYYY HH:MM. Например, 1/1/2013%2000:00~1/2/2013%2000:00. Максимальный временной диапазон — 6 месяцев. | Н/Д | Да |
| единица времени | секунда, минута, час, день, неделя, месяц, квартал, год, десятилетие, век, тысячелетие | Н/Д | Да |
| Сортировать по | Если указаны два или более значений в выпадающем списке, параметр 'sortby' можно использовать для указания списка параметров, используемых для сортировки результатов: message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size, end_point_response_time. | Н/Д | Нет |
| сортировка | Поддерживаемые области сортировки: DESC или ASC | Н/Д | Нет |
| топк | Например, чтобы получить "топ k" результатов, нужно вернуть 5 лучших результатов: "topk=5". | Н/Д | Нет |
| фильтр | Позволяет детализировать значения конкретных измерений. | Н/Д | Нет |
| лимит | Установите ограничение на количество записей, возвращаемых API. | Н/Д | Нет |
| компенсировать | Используйте смещение (offset) вместе с ограничением (limit), чтобы включить постраничную навигацию результатов. Например, чтобы отобразить результаты с 11 по 20, установите ограничение (limit) равным '10' и смещение (offset) равным '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_name. |
| метрики | Показатели для отчета |