Share via

Create Repair Task

  • Article

Creates a new repair task.

For clusters that have the Repair Manager Service configured, this API provides a way to create repair tasks that run automatically or manually. For repair tasks that run automatically, an appropriate repair executor must be running for each repair action to run automatically. These are currently only available in specially-configured Azure Cloud Services.

To create a manual repair task, provide the set of impacted node names and the expected impact. When the state of the created repair task changes to approved, you can safely perform repair actions on those nodes.

This API supports the Service Fabric platform; it is not meant to be used directly from your code.

Request

Method Request URI
POST /$/CreateRepairTask?api-version=6.0

Parameters

Name Type Required Location
api-version string Yes Query
RepairTask RepairTask 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.

RepairTask

Type: RepairTask
Required: Yes

Describes the repair task to be created or updated.

Responses

HTTP Status Code Description Response Schema
200 (OK) A successful operation will return 200 status code.
The response body provides information about the created repair task.
 RepairTaskUpdateInfo
All other status codes The detailed error response.
 FabricError