你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

取消操作

取消用户造成的错误操作。

以下 API 启动可以使用 CancelOperation 取消的错误操作:StartDataLoss、StartQuorumLoss、StartPartitionRestart、StartNodeTransition。

如果 force 为 false,则会正常停止并清理用户造成的指定操作。 如果 force 为 true,则会中止命令,并可能留下一些内部状态。 请谨慎将 force 指定为 true。 除非先在 force 设置为 false 的情况下对相同的 test 命令调用此 API,或者 test 命令已包含值为 OperationState.RollingBack 的 OperationState,否则,不允许在 force 设置为 true 的情况下调用此 API。 澄清:OperationState.RollingBack 表示系统将会/正在清理由于执行该命令而导致的内部系统状态。 如果 test 命令导致数据丢失,则系统不会还原数据。 例如,如果先调用 StartDataLoss,再调用此 API,则系统只会清理由于运行该命令而导致的内部状态。 如果命令的执行时间很长,导致数据丢失,则系统不会还原目标分区的数据。

特别注意:如果在 force==true 的情况下调用此 API,则可能会留下内部状态。

请求

方法 请求 URI
POST /Faults/$/Cancel?api-version=6.0&OperationId={OperationId}&Force={Force}&timeout={timeout}

参数

名称 类型 必须 位置
api-version string 查询
OperationId string (uuid) 查询
Force boolean 查询
timeout 整数 (int64) 查询

api-version

类型:字符串
必需:是
默认

API 的版本。 此参数是必需的,其值必须为“6.0”。

Service Fabric REST API 版本基于引入或更改 API 的运行时版本。 Service Fabric 运行时支持多个版本的 API。 这是 API 的最新受支持版本。 如果传递的 API 版本较低,则返回的响应可能与本规范中所述的响应不同。

此外,运行时接受高于最新支持版本的任何版本,该版本一直高于当前版本的运行时。 因此,如果最新的 API 版本为 6.0,但如果运行时为 6.1,则为了更轻松地编写客户端,运行时将接受该 API 的版本 6.1。 但是,API 的行为将按照记录的 6.0 版本执行。


OperationId

类型:uuid) (字符串
必需:是

用于标识此 API 的调用的 GUID。 这会传递到相应的 GetProgress API 中


Force

类型:布尔值
必需:是
默认

指示是否要正常回滚和清理执行用户造成的操作后修改的内部系统状态。


timeout

类型:整数 (int64)
必需:否
默认
InclusiveMaximum4294967295
InclusiveMinimum1

执行操作的服务器超时,以秒为单位。 此超时指定客户端可以等待请求的操作完成的持续时间。 此参数的默认值为 60 秒。

响应

HTTP 状态代码 说明 响应架构
200 (正常) 成功的操作将返回 200 状态代码。
所有其他状态代码 详细的错误响应。
FabricError