Поделиться через

Работоспособности реплики отчета

  • Статья

Отправляет отчет о работоспособности реплики Service Fabric.

Возвращает состояние работоспособности для указанной реплики Service Fabric. Отчет должен содержать информацию об источнике отчета о работоспособности и свойстве, в котором об этом сообщается. Отчет отправляется к реплике шлюза Service Fabric, которая передает его в хранилище данных о работоспособности. Отчет может быть принят шлюзом, но затем отклонен хранилищем данных о работоспособности после дополнительной проверки. Например, хранилище данных о работоспособности может отклонить отчет из-за недопустимого параметра, например устаревшего порядкового номера. Чтобы узнать, применен ли отчет в хранилище работоспособности, выполните команду GetReplicaHealth и проверка, что отчет отображается в разделе HealthEvents.

Запрос

Метод Универсальный код ресурса (URI) запроса
POST /Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/ReportHealth?api-version=6.0&ServiceKind={ServiceKind}&Immediate={Immediate}&timeout={timeout}

Параметры

Имя Тип Обязательно Расположение
partitionId строка (UUID) Да Путь
replicaId строка Да Путь
api-version строка Да Запрос
ServiceKind string (перечисление) Да Запрос
Immediate Логическое Нет Запрос
timeout целое число (int64) Нет Запрос
HealthInformation HealthInformation да Текст

partitionId

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

Идентификатор секции.

replicaId

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

Идентификатор реплики.

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.

ServiceKind

Тип: string (перечисление)
Обязательный: да
По умолчанию: Stateful

Тип службы реплика (без отслеживания состояния или с отслеживанием состояния), для которого сообщается о работоспособности. Ниже приведены возможные значения. Возможные значения: "Stateless", "Stateful"

Immediate

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

Этот флаг обозначает, что отчет нужно отправить немедленно. Отчет о работоспособности отправляется в приложение шлюза Service Fabric, которое передает его в хранилище данных о работоспособности. Если флагу Immediate задано значение true, отчет немедленно отправляется через шлюз HTTP в хранилище данных о работоспособности, независимо от параметров клиента структуры, которые использует приложение шлюза HTTP. Это полезно для критически важных отчетов, которые необходимо передать как можно быстрее. В зависимости от времени и других условий отправка отчета может завершиться сбоем, например, если шлюз HTTP закрыт или сообщение не достигает этого шлюза. Если флагу Immediate задано значение false, отчет отправляется с учетом параметров клиента работоспособности через шлюз HTTP. Это значит, что он будет включен в пакет отчетов в соответствии со значением параметра HealthReportSendInterval. Рекомендуется применять именно такой вариант, так как он позволяет клиенту работоспособности оптимизировать отправку отчетов в хранилище данных о работоспособности, а также обработку отчетов о работоспособности. По умолчанию отчеты не отправляются немедленно.

timeout

Тип: integer (int64)
Обязательный: нет
По умолчанию: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

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

HealthInformation

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

Описывает сведения о работоспособности для отчета о работоспособности. Эти сведения должны присутствовать во всех отчетах о работоспособности, отправляемых руководителю работоспособности.

Ответы

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