Отмена операции

Статья
07/19/2023

Отменяет операцию при ошибке, вызываемую пользователем.

Следующие API запускают операции при ошибке, которые можно отменить с помощью CancelOperation: StartDataLoss, StartQuorumLoss, StartPartitionRestart, StartNodeTransition.

Если для force задано значение false, то указанная операция, вызываемая пользователем, будет корректно остановлена и очищена. Если для force задано значение true, команда будет прервана и внутреннее состояние может проигнорироваться. Следует с осторожностью использовать true в качестве значения force. Если для force задано значение true, вызов этого API будет запрещен, пока этот API не будет вызван в той же тестовой команде, в которой для force задано значение false, или же если в команде параметр OperationState уже имеет значение OperationState.RollingBack. Уточнение: OperationState.RollingBack означает, что система очистит или очищает внутреннее состояние системы, вызванное выполнением команды. Данные не восстановятся, если тестовая команда привела к их потере. Например, если вызвать StartDataLoss, а затем этот API, система только очистит внутреннее состояние от запуска команды. Данные целевой секции не восстановятся, если команда выполнялась достаточное время, что вызвало потерю данных.

Важное примечание: если этот API вызван со значением true для force, внутреннее состояние может быть проигнорировано.

Запрос

Метод	Универсальный код ресурса (URI) запроса
POST	`/Faults/$/Cancel?api-version=6.0&OperationId={OperationId}&Force={Force}&timeout={timeout}`

Параметры

Имя	Тип	Обязательно	Расположение
`api-version`	строка	Да	Запрос
`OperationId`	строка (UUID)	Да	Запрос
`Force`	Логическое	Да	Запрос
`timeout`	integer (int64)	Нет	Запрос

`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.

`OperationId`

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

Идентификатор GUID, определяющий вызов этого API. Он передается в соответствующий API GetProgress.

`Force`

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

Указывает, следует ли корректно выполнить откат и очистить внутреннее состояние системы, изменяемое при выполнении операции, вызываемой пользователем.

`timeout`

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

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

Ответы

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

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