Получение работоспособности кластера
Возвращает состояние работоспособности кластера Service Fabric.
EventsHealthStateFilter используется для фильтрации получаемой коллекции событий работоспособности кластера на основе состояния работоспособности. Аналогично используются NodesHealthStateFilter и ApplicationsHealthStateFilter для фильтрации получаемой коллекции узлов и приложений на основе их общего состояния работоспособности.
Запрос
| Метод | Универсальный код ресурса (URI) запроса |
|---|---|
| GET | /$/GetClusterHealth?api-version=6.0&NodesHealthStateFilter={NodesHealthStateFilter}&ApplicationsHealthStateFilter={ApplicationsHealthStateFilter}&EventsHealthStateFilter={EventsHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&IncludeSystemApplicationHealthStatistics={IncludeSystemApplicationHealthStatistics}&timeout={timeout} |
Параметры
| Имя | Тип | Обязательно | Расположение |
|---|---|---|---|
api-version |
строка | Да | Запрос |
NodesHealthStateFilter |
Целое число | Нет | Запрос |
ApplicationsHealthStateFilter |
Целое число | Нет | Запрос |
EventsHealthStateFilter |
Целое число | Нет | Запрос |
ExcludeHealthStatistics |
Логическое | Нет | Запрос |
IncludeSystemApplicationHealthStatistics |
Логическое | Нет | Запрос |
timeout |
целое число (int64) | Нет | Запрос |
api-version
Тип: строка
Обязательный: да
По умолчанию: 6.0
Версия API. Этот параметр является обязательным и его значение должно быть "6.0".
Версия REST API Service Fabric основана на версии среды выполнения, в которой api был представлен или изменен. Среда выполнения Service Fabric поддерживает несколько версий API. Это последняя поддерживаемая версия API. Если передается более ранжная версия API, возвращаемый ответ может отличаться от той, что описано в этой спецификации.
Кроме того, среда выполнения принимает любую версию, которая выше последней поддерживаемой версии, вплоть до текущей версии среды выполнения. Таким образом, если последняя версия API — 6.0, а среда выполнения — 6.1, чтобы упростить запись клиентов, среда выполнения примет версию 6.1 для этого API. Однако поведение API будет выполняться согласно описанной версии 6.0.
NodesHealthStateFilter
Тип: целое число
Обязательный: нет
По умолчанию: 0
Позволяет фильтровать объекты состояния работоспособности узла, возвращаемые в результате запроса работоспособности кластера, по состоянию работоспособности. Возможные значения для этого параметра — целочисленное значение одного из приведенных ниже состояний работоспособности. Возвращаются только те узлы, которые соответствуют заданному фильтру. Для оценки общего состояния работоспособности используются все узлы.
Если фильтр не указан, возвращаются все записи.
Значения состояния представляют собой перечисление на основе флага, поэтому значение может представлять собой сочетание этих значений, полученное с помощью битового оператора "ИЛИ".
Например, если указано значение 6, то возвращается состояние работоспособности узлов со значениями HealthState "OK" (2) и "Warning" (4).
- По умолчанию — значение по умолчанию. Соответствует любому значению HealthState. Значение равно нулю.
- None — фильтр, который не соответствует ни одному значению HealthState. Используется для возвращения нуля результатов для определенной коллекции состояний. Значение равно 1.
- ОК — фильтр, соответствующий входным данным, со значением HealthState ОК. Значение равно 2.
- Предупреждение — фильтр, соответствующий входным данным со значением HealthState Warning. Значение равно 4.
- Ошибка — фильтр, соответствующий входным данным со значением HealthState Error. Значение равно 8.
- Все — фильтр, соответствующий входным данным с любым значением HealthState. Значение равно 65 535.
ApplicationsHealthStateFilter
Тип: целое число
Обязательный: нет
По умолчанию: 0
Позволяет фильтровать объекты состояния работоспособности приложения, возвращаемые в результате запроса работоспособности кластера, по состоянию работоспособности.
Возможные значения для этого параметра — целочисленное значение, полученное от элементов или битовых операций над элементами перечисления HealthStateFilter. Возвращаются только те приложения, которые соответствуют заданному фильтру.
Для оценки общего состояния работоспособности используются все приложения. Если фильтр не указан, возвращаются все записи.
Значения состояния представляют собой перечисление на основе флага, поэтому значение может представлять собой сочетание этих значений, полученное с помощью битового оператора "ИЛИ".
Например, если указано значение 6, то возвращается состояние работоспособности приложений со значениями HealthState "OK" (2) и "Warning" (4).
- По умолчанию — значение по умолчанию. Соответствует любому значению HealthState. Значение равно нулю.
- None — фильтр, который не соответствует ни одному значению HealthState. Используется для возвращения нуля результатов для определенной коллекции состояний. Значение равно 1.
- ОК — фильтр, соответствующий входным данным, со значением HealthState ОК. Значение равно 2.
- Предупреждение — фильтр, соответствующий входным данным со значением HealthState Warning. Значение равно 4.
- Ошибка — фильтр, соответствующий входным данным со значением HealthState Error. Значение равно 8.
- Все — фильтр, соответствующий входным данным с любым значением HealthState. Значение равно 65 535.
EventsHealthStateFilter
Тип: целое число
Обязательный: нет
По умолчанию: 0
Позволяет отфильтровать коллекцию возвращаемых объектов HealthEvent по состоянию работоспособности.
Возможные значения для этого параметра — целочисленное значение одного из приведенных ниже состояний работоспособности.
Возвращаются только те события, которые соответствуют заданному фильтру. Для оценки общего состояния работоспособности используются все события.
Если фильтр не указан, возвращаются все записи. Значения состояния — это перечисление на основе флага, поэтому значение может представлять собой сочетание этих значений, полученное с помощью битового оператора OR. Например, если указано значение 6, то возвращаются все события со значениями HealthState "ОК" (2) и "Warning" (4).
- По умолчанию — значение по умолчанию. Соответствует любому значению HealthState. Значение равно нулю.
- None — фильтр, который не соответствует ни одному значению HealthState. Используется для возвращения нуля результатов для определенной коллекции состояний. Значение равно 1.
- ОК — фильтр, соответствующий входным данным, со значением HealthState ОК. Значение равно 2.
- Предупреждение — фильтр, который соответствует входным данным со значением HealthState Warning. Значение равно 4.
- Ошибка — фильтр, который соответствует входным данным со значением HealthState Error. Значение равно 8.
- Все — фильтр, соответствующий входным данным с любым значением HealthState. Значение равно 65 535.
ExcludeHealthStatistics
Тип: boolean
Обязательный: нет
По умолчанию: false
Указывает, должна ли возвращаться статистика работоспособности в составе результатов запроса. Значение по умолчанию: false.
Статистика содержит число дочерних сущностей в состоянии работоспособности OK, Warning и Error.
IncludeSystemApplicationHealthStatistics
Тип: boolean
Обязательный: нет
По умолчанию: false
Указывает, следует ли включать в статистику работоспособности сведения о приложении fabric:/System. Значение по умолчанию: false.
Если для IncludeSystemApplicationHealthStatistics задано значение true, то статистика работоспособности включает в себя сущности, относящиеся к приложению fabric:/System.
В противном случае результат запроса содержит только статистику работоспособности приложений пользователя.
Для применения этого параметра в результат запроса должна быть включена статистика работоспособности.
timeout
Тип: integer (int64)
Обязательный: нет
По умолчанию: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд.
Ответы
| Код состояния HTTP | Описание | схеме ответа. |
|---|---|---|
| 200 OK; | Успешная операция вернет код состояния 200 и запрошенные сведения о работоспособности кластера. |
ClusterHealth |
| Все остальные коды состояния | Подробный ответ об ошибке. |
FabricError |