Получение списка событий приложений

  • Статья

Показывает все события, связанные с Приложениями.

Ответ на запрос представляет собой список объектов ApplicationEvent.

Запрос

Метод Универсальный код ресурса (URI) запроса
GET /EventsStore/Applications/Events?api-version=6.4&timeout={timeout}&StartTimeUtc={StartTimeUtc}&EndTimeUtc={EndTimeUtc}&EventsTypesFilter={EventsTypesFilter}&ExcludeAnalysisEvents={ExcludeAnalysisEvents}&SkipCorrelationLookup={SkipCorrelationLookup}

Параметры

Имя Тип Обязательно Расположение
api-version строка Да Запрос
timeout integer (int64) Нет Запрос
StartTimeUtc строка Да Запрос
EndTimeUtc строка Да Запрос
EventsTypesFilter строка Нет Запрос
ExcludeAnalysisEvents Логическое Нет Запрос
SkipCorrelationLookup Логическое Нет Запрос

api-version

Тип: string
Обязательный: да
По умолчанию: 6.4

Версия API. Этот параметр является обязательным и его значение должно быть "6,4".

Версия REST API Service Fabric основана на версии среды выполнения, в которой api был представлен или был изменен. Среда выполнения Service Fabric поддерживает несколько версий API. Эта версия является последней поддерживаемой версией API. Если передается более ранжная версия API, возвращаемый ответ может отличаться от ответа, описанного в этой спецификации.

Кроме того, среда выполнения принимает любую версию, которая выше последней поддерживаемой версии, вплоть до текущей версии среды выполнения. Поэтому если последняя версия API — 6.0, а среда выполнения — 6.1, среда выполнения будет принимать версию 6.1 для этого API. Однако поведение API будет выполняться в документе версии 6.0.

timeout

Тип: integer (int64)
Обязательный: нет
По умолчанию: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд.

StartTimeUtc

Тип: string
Обязательный: да

Время начала поискового запроса в формате UTC в соответствии с ISO гггг-ММ-ддТЧЧ:мм:ssZ.

EndTimeUtc

Тип: string
Обязательный: да

Время окончания поискового запроса в формате UTC в соответствии с ISO гггг-ММ-ддТЧЧ:мм:ssZ.

EventsTypesFilter

Тип: string
Обязательный: нет

Эта строка с разделителями-запятыми определяет только типы FabricEvents, которые должны быть включены в ответ.

ExcludeAnalysisEvents

Тип: boolean
Обязательный: нет

Этот параметр отключает получение AnalysisEvents, если передается значение True.

SkipCorrelationLookup

Тип: boolean
Обязательный: нет

Этот параметр отключает поиск сведений об CorrelatedEvents, если передается значение True. в противном случае выполняется обработка CorrelationEvents и заполняется поле HasCorrelatedEvents в каждом FabricEvent.

Ответы

Код состояния HTTP Описание схеме ответа.
200 OK; Список объектов событий с базовым типом ApplicationEvent.
 Массив ApplicationEvent
Все остальные коды состояния Подробный ответ об ошибке.
 FabricError

Примеры

В этом примере показано, как получить все события, связанные с приложениями, в течение определенного периода времени.

Запрос

GET http://localhost:19080/EventsStore/Applications/Events?api-version=6.4&StartTimeUtc=2018-04-03T18:00:00Z&EndTimeUtc=2018-04-04T18:00:00Z

Ответ 200

Текст
[
  {
    "Kind": "ApplicationCreated",
    "ApplicationTypeName": "App1Type",
    "ApplicationTypeVersion": "1.0.1",
    "ApplicationDefinitionKind": "ServiceFabricApplicationDescription",
    "ApplicationId": "app1",
    "EventInstanceId": "8a7a0c42-67ca-4cd3-9160-edcdb822db10",
    "TimeStamp": "2018-04-03T20:21:23.5774199Z",
    "HasCorrelatedEvents": false
  },
  {
    "Kind": "ApplicationCreated",
    "ApplicationTypeName": "App2Type",
    "ApplicationTypeVersion": "4.0.1",
    "ApplicationDefinitionKind": "ServiceFabricApplicationDescription",
    "ApplicationId": "app2",
    "EventInstanceId": "d50574bc-6a31-4945-8275-7639bec7a0b3",
    "TimeStamp": "2018-04-03T20:21:59.74842Z",
    "HasCorrelatedEvents": false
  }
]