Получение работоспособности реплики с помощью политики

Возвращает работоспособность Service Fabric реплики службы с отслеживанием состояния или экземпляра службы без отслеживания состояния с помощью указанной политики.

Возвращает сведения о работоспособности реплики службы с отслеживанием состояния или экземпляра службы без отслеживания состояния Service Fabric. EventsHealthStateFilter используется для фильтрации получаемой коллекции событий работоспособности кластера на основе состояния работоспособности. Используйте ApplicationHealthPolicy, чтобы при необходимости переопределить политики работоспособности, используемые для оценки работоспособности. Этот API использует только поле "ConsiderWarningAsError" объекта ApplicationHealthPolicy. Остальные поля игнорируются при оценке работоспособности реплики.

Запрос

Метод Универсальный код ресурса (URI) запроса
POST /Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&timeout={timeout}

Параметры

Имя Тип Обязательно Location
partitionId строка (UUID) Да Путь
replicaId строка Да Путь
api-version строка Да Запрос
EventsHealthStateFilter Целое число Нет Запрос
timeout целое число (int64) Нет Запрос
ApplicationHealthPolicy ApplicationHealthPolicy Нет Текст

partitionId

Тип: строка (uuid)
Обязательный: да

Идентификатор секции.


replicaId

Тип: строка
Обязательный: да

Идентификатор реплики.


api-version

Тип: строка
Обязательный: да
По умолчанию: 6.0

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

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

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


EventsHealthStateFilter

Тип: целое число
Обязательный: нет
По умолчанию: 0

Позволяет отфильтровать коллекцию возвращаемых объектов HealthEvent по состоянию работоспособности. Возможные значения для этого параметра — целочисленное значение одного из приведенных ниже состояний работоспособности. Возвращаются только те события, которые соответствуют заданному фильтру. Для оценки общего состояния работоспособности используются все события. Если фильтр не указан, возвращаются все записи. Значения состояния — это перечисление на основе флага, поэтому значение может представлять собой сочетание этих значений, полученное с помощью битового оператора OR. Например, если указано значение 6, то возвращаются все события со значениями HealthState "ОК" (2) и "Warning" (4).

  • По умолчанию — значение по умолчанию. Соответствует любому значению HealthState. Значение равно нулю.
  • None — фильтр, который не соответствует значению HealthState. Используется для возвращения нуля результатов для определенной коллекции состояний. Значение равно 1.
  • Ok — фильтр, соответствующий входным данным со значением HealthState Ok. Значение равно 2.
  • Предупреждение — фильтр, соответствующий входным данным со значением HealthState Warning. Значение равно 4.
  • Ошибка — фильтр, соответствующий входным данным со значением HealthState. Значение равно 8.
  • All — фильтр, соответствующий входным данным со значением HealthState. Значение равно 65 535.

timeout

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

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


ApplicationHealthPolicy

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

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

Ответы

Код состояния HTTP Описание схеме ответа.
200 OK; Успешная операция вернет код состояния 200 и запрошенную информацию о работоспособности реплики.
ReplicaHealth
Все остальные коды состояния Подробный ответ об ошибке.
FabricError