Получение работоспособности секции с помощью политики
Возвращает сведения о работоспособности указанной секции Service Fabric с помощью указанной политики работоспособности.
Возвращает сведения о работоспособности указанной секции. Если указана политика работоспособности приложения, оценка работоспособности использует ее для получения агрегированного состояния работоспособности. Если политика не указана, при оценке работоспособности используется политика работоспособности приложения, определенная в манифесте приложения, или политика работоспособности по умолчанию, если политика не определена в манифесте. Используйте EventsHealthStateFilter для фильтрации коллекции событий работоспособности, сообщаемых в секции, на основе состояния работоспособности. ReplicasHealthStateFilter используется для фильтрации коллекции объектов ReplicaHealthState для секции. Используйте ApplicationHealthPolicy в тексте POST, чтобы переопределить политики работоспособности, используемые для оценки работоспособности. Если указанная секция не существует в хранилище данных о работоспособности, то этот запрос возвращает ошибку.
Запрос
| Метод | Универсальный код ресурса (URI) запроса |
|---|---|
| POST | /Partitions/{partitionId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&ReplicasHealthStateFilter={ReplicasHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout} |
Параметры
| Имя | Тип | Обязательно | Расположение |
|---|---|---|---|
partitionId |
строка (UUID) | Да | Путь |
api-version |
строка | Да | Запрос |
EventsHealthStateFilter |
Целое число | Нет | Запрос |
ReplicasHealthStateFilter |
Целое число | Нет | Запрос |
ExcludeHealthStatistics |
Логическое | Нет | Запрос |
timeout |
integer (int64) | Нет | Запрос |
ApplicationHealthPolicy |
ApplicationHealthPolicy | Нет | Текст |
partitionId
Тип: string (uuid)
Обязательный: да
Идентификатор секции.
api-version
Тип: string
Обязательный: да
По умолчанию: 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.
EventsHealthStateFilter
Тип: целое число
Обязательный: нет
По умолчанию: 0
Позволяет отфильтровать коллекцию возвращаемых объектов HealthEvent по состоянию работоспособности.
Возможные значения для этого параметра — целочисленное значение одного из приведенных ниже состояний работоспособности.
Возвращаются только те события, которые соответствуют заданному фильтру. Для оценки общего состояния работоспособности используются все события.
Если фильтр не указан, возвращаются все записи. Значения состояния — это перечисление на основе флага, поэтому значение может представлять собой сочетание этих значений, полученное с помощью битового оператора OR. Например, если указано значение 6, то возвращаются все события со значениями HealthState "ОК" (2) и "Warning" (4).
- По умолчанию — значение по умолчанию. Соответствует любому значению HealthState. Значение равно нулю.
- None — фильтр, который не соответствует ни одному значению HealthState. Используется для возвращения нуля результатов для определенной коллекции состояний. Значение равно 1.
- ОК — фильтр, соответствующий входным данным, со значением HealthState ОК. Значение равно 2.
- Предупреждение — фильтр, который соответствует входным данным со значением HealthState Warning. Значение равно 4.
- Ошибка — фильтр, который соответствует входным данным со значением HealthState Error. Значение равно 8.
- Все — фильтр, соответствующий входным данным с любым значением HealthState. Значение равно 65 535.
ReplicasHealthStateFilter
Тип: целое число
Обязательный: нет
По умолчанию: 0
Позволяет фильтровать коллекцию объектов ReplicaHealthState для секции. Это значение можно получить из элементов HealthStateFilter или с помощью битовых операций с элементами HealthStateFilter. Возвратятся только те реплики, которые соответствуют заданному фильтру. Для оценки общего состояния работоспособности будут использоваться все реплики. Если фильтр не указан, возвратятся все записи. Значения состояния — это перечисление на основе флага. Поэтому значение может представлять собой сочетание этих значений, полученное с помощью битового оператора OR. Например, если указано значение 6, то возвратятся все события со значениями HealthState "OK" (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.
timeout
Тип: integer (int64)
Обязательный: нет
По умолчанию: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд.
ApplicationHealthPolicy
Тип: ApplicationHealthPolicy
Обязательный: нет
Описывает политики работоспособности, используемые для оценки работоспособности приложения или одного из его дочерних элементов.
Если он отсутствует, при оценке работоспособности используется политика работоспособности из манифеста приложения или политика работоспособности по умолчанию.
Ответы
| Код состояния HTTP | Описание | схеме ответа. |
|---|---|---|
| 200 OK; | Успешная операция возвращает код состояния 200 и сведения о работоспособности указанной секции. |
PartitionHealth |
| Все остальные коды состояния | Подробный ответ об ошибке. |
FabricError |