ServiceFabricClientGetClusterHealthOptionalParams interface

Пакет:
@azure/servicefabric

Необязательные параметры.

Extends
RequestOptionsBase

Свойства

applicationsHealthStateFilter

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

  • Значение по умолчанию — значение по умолчанию. Соответствует любому состоянию работоспособности. Значение равно нулю.
  • Нет — фильтр, который не соответствует значению HealthState. Используется для возврата результатов для определенной коллекции состояний. Значение равно 1.
  • Ok — фильтр, соответствующий входным данным со значением HealthState Ok. Значение равно 2.
  • Предупреждение — фильтр, соответствующий входным данным со значением HealthState. Значение равно 4.
  • Ошибка — фильтр, соответствующий входным данным со значением HealthState. Значение равно 8.
  • All — фильтр, соответствующий входным данным с любым значением HealthState. Значение равно 65535. Значение по умолчанию: 0.
eventsHealthStateFilter

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

  • Значение по умолчанию — значение по умолчанию. Соответствует любому состоянию работоспособности. Значение равно нулю.
  • Нет — фильтр, который не соответствует значению HealthState. Используется для возврата результатов для определенной коллекции состояний. Значение равно 1.
  • Ok — фильтр, соответствующий входным данным со значением HealthState Ok. Значение равно 2.
  • Предупреждение — фильтр, соответствующий входным данным со значением HealthState. Значение равно 4.
  • Ошибка — фильтр, соответствующий входным данным со значением HealthState. Значение равно 8.
  • All — фильтр, соответствующий входным данным с любым значением HealthState. Значение равно 65535. Значение по умолчанию: 0.
excludeHealthStatistics

Указывает, следует ли возвращать статистику работоспособности в рамках результата запроса. Значение false по умолчанию. Статистика показывает количество дочерних сущностей в состоянии работоспособности "ОК", "Предупреждение" и "Ошибка". Значение по умолчанию: false.
includeSystemApplicationHealthStatistics

Указывает, должна ли статистика работоспособности включать статистику работоспособности приложений структуры:/System Application Health Statistics. Значение false по умолчанию. Если параметр IncludeSystemApplicationHealthStatistics имеет значение true, статистика работоспособности включает сущности, принадлежащие структуре:/System application. В противном случае результат запроса содержит статистику работоспособности только для пользовательских приложений. Статистика работоспособности должна быть включена в результат запроса для применения этого параметра. Значение по умолчанию: false.
nodesHealthStateFilter

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

  • Значение по умолчанию — значение по умолчанию. Соответствует любому состоянию работоспособности. Значение равно нулю.
  • Нет — фильтр, который не соответствует значению HealthState. Используется для возврата результатов для определенной коллекции состояний. Значение равно 1.
  • Ok — фильтр, соответствующий входным данным со значением HealthState Ok. Значение равно 2.
  • Предупреждение — фильтр, соответствующий входным данным со значением HealthState. Значение равно 4.
  • Ошибка — фильтр, соответствующий входным данным со значением HealthState. Значение равно 8.
  • All — фильтр, соответствующий входным данным с любым значением HealthState. Значение равно 65535. Значение по умолчанию: 0.
timeoutParameter

Время ожидания сервера для выполнения операции в секундах. Это время ожидания указывает длительность времени, которую клиент готов ждать завершения запрошенной операции. Значение по умолчанию для этого параметра составляет 60 секунд. Значение по умолчанию: 60.

Унаследованные свойства

abortSignal

Сигнал, который можно использовать для прерывания запросов.
customHeaders

Пользовательские заголовки запросов, которые будут применены перед отправкой запроса.
onDownloadProgress

Обратный вызов, который запускается при выполнении скачивания.
onUploadProgress

Обратный вызов, который запускается при выполнении отправки.
timeout

Число миллисекундах запроса может приниматься перед автоматическим завершением.

Сведения о свойстве

applicationsHealthStateFilter

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

  • Значение по умолчанию — значение по умолчанию. Соответствует любому состоянию работоспособности. Значение равно нулю.
  • Нет — фильтр, который не соответствует значению HealthState. Используется для возврата результатов для определенной коллекции состояний. Значение равно 1.
  • Ok — фильтр, соответствующий входным данным со значением HealthState Ok. Значение равно 2.
  • Предупреждение — фильтр, соответствующий входным данным со значением HealthState. Значение равно 4.
  • Ошибка — фильтр, соответствующий входным данным со значением HealthState. Значение равно 8.
  • All — фильтр, соответствующий входным данным с любым значением HealthState. Значение равно 65535. Значение по умолчанию: 0.
applicationsHealthStateFilter?: number

Значение свойства

number

eventsHealthStateFilter

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

  • Значение по умолчанию — значение по умолчанию. Соответствует любому состоянию работоспособности. Значение равно нулю.
  • Нет — фильтр, который не соответствует значению HealthState. Используется для возврата результатов для определенной коллекции состояний. Значение равно 1.
  • Ok — фильтр, соответствующий входным данным со значением HealthState Ok. Значение равно 2.
  • Предупреждение — фильтр, соответствующий входным данным со значением HealthState. Значение равно 4.
  • Ошибка — фильтр, соответствующий входным данным со значением HealthState. Значение равно 8.
  • All — фильтр, соответствующий входным данным с любым значением HealthState. Значение равно 65535. Значение по умолчанию: 0.
eventsHealthStateFilter?: number

Значение свойства

number

excludeHealthStatistics

Указывает, следует ли возвращать статистику работоспособности в рамках результата запроса. Значение false по умолчанию. Статистика показывает количество дочерних сущностей в состоянии работоспособности "ОК", "Предупреждение" и "Ошибка". Значение по умолчанию: false.

excludeHealthStatistics?: boolean

Значение свойства

boolean

includeSystemApplicationHealthStatistics

Указывает, должна ли статистика работоспособности включать статистику работоспособности приложений структуры:/System Application Health Statistics. Значение false по умолчанию. Если параметр IncludeSystemApplicationHealthStatistics имеет значение true, статистика работоспособности включает сущности, принадлежащие структуре:/System application. В противном случае результат запроса содержит статистику работоспособности только для пользовательских приложений. Статистика работоспособности должна быть включена в результат запроса для применения этого параметра. Значение по умолчанию: false.

includeSystemApplicationHealthStatistics?: boolean

Значение свойства

boolean

nodesHealthStateFilter

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

  • Значение по умолчанию — значение по умолчанию. Соответствует любому состоянию работоспособности. Значение равно нулю.
  • Нет — фильтр, который не соответствует значению HealthState. Используется для возврата результатов для определенной коллекции состояний. Значение равно 1.
  • Ok — фильтр, соответствующий входным данным со значением HealthState Ok. Значение равно 2.
  • Предупреждение — фильтр, соответствующий входным данным со значением HealthState. Значение равно 4.
  • Ошибка — фильтр, соответствующий входным данным со значением HealthState. Значение равно 8.
  • All — фильтр, соответствующий входным данным с любым значением HealthState. Значение равно 65535. Значение по умолчанию: 0.
nodesHealthStateFilter?: number

Значение свойства

number

timeoutParameter

Время ожидания сервера для выполнения операции в секундах. Это время ожидания указывает длительность времени, которую клиент готов ждать завершения запрошенной операции. Значение по умолчанию для этого параметра составляет 60 секунд. Значение по умолчанию: 60.

timeoutParameter?: number

Значение свойства

number

Сведения об унаследованном свойстве

abortSignal

Сигнал, который можно использовать для прерывания запросов.

abortSignal?: AbortSignalLike

Значение свойства

AbortSignalLike

наследуется от msRest.RequestOptionsBase.abortSignal

customHeaders

Пользовательские заголовки запросов, которые будут применены перед отправкой запроса.

customHeaders?: {[key: string]: string}

Значение свойства

{[key: string]: string}

наследуется от msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Обратный вызов, который запускается при выполнении скачивания.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Значение свойства

(progress: TransferProgressEvent) => void

наследуется от msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Обратный вызов, который запускается при выполнении отправки.

onUploadProgress?: (progress: TransferProgressEvent) => void

Значение свойства

(progress: TransferProgressEvent) => void

наследуется от msRest.RequestOptionsBase.onUploadProgress

timeout

Число миллисекундах запроса может приниматься перед автоматическим завершением.

timeout?: number

Значение свойства

number

наследуется от msRest.RequestOptionsBase.timeout