Sign in
Swagger 2.02026-07-132346811.1 MB

6df9f2f4d542

RepairManagement

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.

get/$/GetRepairTaskList

Query parameters

api-version'6.0' required

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.

TaskIdFilterstring

The repair task ID prefix to be matched.

StateFilterinteger

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
ExecutorFilterstring

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

Response

A successful operation will return 200 status code. The response body provides a list of repair tasks matching all of the given filters.

TaskIdstring required

The ID of the repair task.

Versionstring

The version of the repair task. When creating a new repair task, the version must be set to zero. When updating a repair task, the version is used for optimistic concurrency checks. If the version is set to zero, the update will not check for write conflicts. If the version is set to a non-zero value, then the update will only succeed if the actual current version of the repair task matches this value.

Descriptionstring

A description of the purpose of the repair task, or other informational details. May be set when the repair task is created, and is immutable once set.

State'Invalid' | 'Created' | 'Claimed' | 'Preparing' | 'Approved' | 'Executing' | 'Restoring' | 'Completed' required

The workflow state of the repair task. Valid initial states are Created, Claimed, and Preparing.

Flagsinteger

A bitwise-OR of the following values, which gives additional details about the status of the repair task.

  • 1 - Cancellation of the repair has been requested
  • 2 - Abort of the repair has been requested
  • 4 - Approval of the repair was forced via client request
Actionstring required

The requested repair action. Must be specified when the repair task is created, and is immutable once set.

Executorstring

The name of the repair executor. Must be specified in Claimed and later states, and is immutable once set.

ExecutorDatastring

A data string that the repair executor can use to store its internal state.

ResultStatus'Invalid' | 'Succeeded' | 'Cancelled' | 'Interrupted' | 'Failed' | 'Pending'

A value describing the overall result of the repair task execution. Must be specified in the Restoring and later states, and is immutable once set.

ResultCodeinteger

A numeric value providing additional details about the result of the repair task execution. May be specified in the Restoring and later states, and is immutable once set.

ResultDetailsstring

A string providing additional details about the result of the repair task execution. May be specified in the Restoring and later states, and is immutable once set.

PreparingHealthCheckState'NotStarted' | 'InProgress' | 'Succeeded' | 'Skipped' | 'TimedOut'

Specifies the workflow state of a repair task's health check. This type supports the Service Fabric platform; it is not meant to be used directly from your code.

RestoringHealthCheckState'NotStarted' | 'InProgress' | 'Succeeded' | 'Skipped' | 'TimedOut'

Specifies the workflow state of a repair task's health check. This type supports the Service Fabric platform; it is not meant to be used directly from your code.

PerformPreparingHealthCheckboolean

A value to determine if health checks will be performed when the repair task enters the Preparing state.

PerformRestoringHealthCheckboolean

A value to determine if health checks will be performed when the repair task enters the Restoring state.