Cancel Repair Task
Requests the cancellation of the given repair task.
This API supports the Service Fabric platform; it is not meant to be used directly from your code.
Request
| Method | Request URI |
|---|---|
| POST | /$/CancelRepairTask?api-version=6.0 |
Parameters
| Name | Type | Required | Location |
|---|---|---|---|
api-version |
string | Yes | Query |
RepairTaskCancelDescription |
RepairTaskCancelDescription | Yes | Body |
api-version
Type: string
Required: Yes
Default: 6.0
The version of the API. This parameter is required and its value must be '6.0'.
Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.
Additionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.
RepairTaskCancelDescription
Type: RepairTaskCancelDescription
Required: Yes
Describes the repair task to be cancelled.
Responses
| HTTP Status Code | Description | Response Schema |
|---|---|---|
| 200 (OK) | A successful operation will return 200 status code. The response body provides information about the updated repair task. Success indicates that the cancellation request was recorded, but does not guarantee that the repair task will be cancelled. Clients may use the State property of the repair task to determine the current state of the repair task. |
RepairTaskUpdateInfo |
| All other status codes | The detailed error response. |
FabricError |