Get Repair Task List

  • Article

Gets a list of repair tasks matching the given filters.

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

Request

Method Request URI
GET /$/GetRepairTaskList?api-version=6.0&TaskIdFilter={TaskIdFilter}&StateFilter={StateFilter}&ExecutorFilter={ExecutorFilter}

Parameters

Name Type Required Location
api-version string Yes Query
TaskIdFilter string No Query
StateFilter integer No Query
ExecutorFilter string No Query

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.

TaskIdFilter

Type: string
Required: No

The repair task ID prefix to be matched.

StateFilter

Type: integer
Required: No

A bitwise-OR of the following values, specifying which task states should be included in the result list.

  • 1 - Created
  • 2 - Claimed
  • 4 - Preparing
  • 8 - Approved
  • 16 - Executing
  • 32 - Restoring
  • 64 - Completed

ExecutorFilter

Type: string
Required: No

The name of the repair executor whose claimed tasks should be included in the list.

Responses

HTTP Status Code Description Response Schema
200 (OK) A successful operation will return 200 status code.
The response body provides a list of repair tasks matching all of the given filters.
 array of RepairTask
All other status codes The detailed error response.
 FabricError