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

  • Статья

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

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

Запрос

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

Параметры

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

nodeName

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

Имя узла.

applicationId

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

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

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.

DeployedServicePackagesHealthStateFilter

Тип: целое число
Обязательный: нет
По умолчанию: 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 и сведения о работоспособности развернутого приложения.
 DeployedApplicationHealth
Все остальные коды состояния Подробный ответ об ошибке.
 FabricError