Получение фрагмента работоспособности кластера с помощью политики и расширенных фильтров
Возвращает сведения о работоспособности кластера Service Fabric с помощью блоков работоспособности.
Возвращает сведения о работоспособности кластера Service Fabric с помощью блоков работоспособности. Оценка работоспособности выполняется на основе описания запроса к блоку работоспособности входного кластера. Описание запроса позволяет пользователям указать политики работоспособности для оценки кластера и его дочерних элементов. Пользователи могут указать очень гибкие фильтры, чтобы выбрать возвращаемые сущности кластера. Выбор можно выполнить на основе состояния работоспособности сущностей и иерархии. Запрос может возвращать многоуровневые дочерние элементы сущностей на основе указанных фильтров. Например, он может вернуть одно приложение с указанным именем, а для этого приложения — только службы, которые находятся в разделе Ошибка или Предупреждение, а также все секции и реплики для одной из этих служб.
Запрос
| Метод | Универсальный код ресурса (URI) запроса |
|---|---|
| POST | /$/GetClusterHealthChunk?api-version=6.0&timeout={timeout} |
Параметры
| Имя | Тип | Обязательно | Расположение |
|---|---|---|---|
api-version |
строка | Да | Запрос |
timeout |
integer (int64) | Нет | Запрос |
ClusterHealthChunkQueryDescription |
ClusterHealthChunkQueryDescription | Нет | Текст |
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.
timeout
Тип: integer (int64)
Обязательный: нет
По умолчанию: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд.
ClusterHealthChunkQueryDescription
Тип: ClusterHealthChunkQueryDescription
Обязательный: нет
Описывает политики работоспособности кластера и приложений, используемые для оценки работоспособности кластера, и фильтры для выбора возвращаемых сущностей кластера.
Если политика работоспособности кластера присутствует, она используется для оценки событий кластера и узлов кластера. Если она отсутствует, для оценки работоспособности используется политика работоспособности кластера, определенная в манифесте кластера, или политика работоспособности кластера по умолчанию.
По умолчанию каждое приложение оценивается с помощью определенной политики работоспособности приложения, определенной в манифесте приложения, или политики работоспособности по умолчанию, если в манифесте не определена политика.
Если схема политики работоспособности приложения указана и в ней есть запись для приложения, для оценки работоспособности приложения используется указанная политика работоспособности приложения.
Пользователи могут указать очень гибкие фильтры, чтобы выбрать, какие сущности кластера следует включить в ответ. Выбор можно выполнить на основе состояния работоспособности сущностей и иерархии.
Запрос может возвращать многоуровневые дочерние элементы сущностей на основе указанных фильтров. Например, он может вернуть одно приложение с указанным именем, а для этого приложения — только службы, которые находятся в разделе Ошибка или Предупреждение, а также все секции и реплики для одной из этих служб.
Ответы
| Код состояния HTTP | Описание | схеме ответа. |
|---|---|---|
| 200 OK; | Успешная операция вернет код состояния 200 и запрошенные сведения о работоспособности кластера. |
ClusterHealthChunk |
| Все остальные коды состояния | Подробный ответ об ошибке. |
FabricError |