Получение работоспособности приложения

  • Статья

Возвращает сведения о работоспособности приложения Service Fabric.

Возвращает состояние работоспособности приложения Service Fabric. Ответ содержит значение состояния работоспособности "Ok" (приложение работоспособно), "Error" (произошла ошибка) или "Warning" (Предупреждение). Если сущность не найдена в хранилище данных о работоспособности, возвращается значение Error.

Запрос

Метод Универсальный код ресурса (URI) запроса
GET /Applications/{applicationId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&DeployedApplicationsHealthStateFilter={DeployedApplicationsHealthStateFilter}&ServicesHealthStateFilter={ServicesHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout}

Параметры

Имя Тип Обязательно Расположение
applicationId строка Да Путь
api-version строка Да Запрос
EventsHealthStateFilter Целое число Нет Запрос
DeployedApplicationsHealthStateFilter Целое число Нет Запрос
ServicesHealthStateFilter Целое число Нет Запрос
ExcludeHealthStatistics Логическое Нет Запрос
timeout целое число (int64) Нет Запрос

applicationId

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

Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1".

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.

EventsHealthStateFilter

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

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

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

DeployedApplicationsHealthStateFilter

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

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

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

ServicesHealthStateFilter

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

Позволяет фильтровать объекты состояния работоспособности служб, возвращаемые в результате запроса работоспособности службы, по состоянию работоспособности. Возможные значения для этого параметра — целочисленное значение одного из приведенных ниже состояний работоспособности. Возвращаются только те службы, которые соответствуют заданному фильтру. Для оценки общего состояния работоспособности используются все службы. Если фильтр не указан, возвращаются все записи. Значения состояния — это перечисление на основе флага, поэтому значение может представлять собой сочетание этих значений, полученное с помощью битового оператора 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 секунд.

Ответы

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