Get Fault Operation List

  • Article

Gets a list of user-induced fault operations filtered by provided input.

Gets the list of user-induced fault operations filtered by provided input.

Request

Method Request URI
GET /Faults/?api-version=6.0&TypeFilter={TypeFilter}&StateFilter={StateFilter}&timeout={timeout}

Parameters

Name Type Required Location
api-version string Yes Query
TypeFilter integer Yes Query
StateFilter integer Yes Query
timeout integer (int64) 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.

TypeFilter

Type: integer
Required: Yes
Default: 65535

Used to filter on OperationType for user-induced operations.

  • 65535 - select all
  • 1 - select PartitionDataLoss.
  • 2 - select PartitionQuorumLoss.
  • 4 - select PartitionRestart.
  • 8 - select NodeTransition.

StateFilter

Type: integer
Required: Yes
Default: 65535

Used to filter on OperationState's for user-induced operations.

  • 65535 - select All
  • 1 - select Running
  • 2 - select RollingBack
  • 8 - select Completed
  • 16 - select Faulted
  • 32 - select Cancelled
  • 64 - select ForceCancelled

timeout

Type: integer (int64)
Required: No
Default: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.

Responses

HTTP Status Code Description Response Schema
200 (OK) A successful operation will return 200 status code.
 array of OperationStatus
All other status codes The detailed error response.
 FabricError

Examples

Gets information on fault operations

This shows an example of possible output for GetFaultOperationList

Request

GET http://localhost:19080/Faults/?api-version=6.0&TypeFilter=0xFF&StateFilter=0xFF

200 Response

Body
[
  {
    "OperationId": "00000000-0000-0000-0000-000000000010",
    "State": "Completed",
    "Type": "PartitionDataLoss"
  },
  {
    "OperationId": "00000000-0000-0000-0000-000000000020",
    "State": "Completed",
    "Type": "PartitionQuorumLoss"
  },
  {
    "OperationId": "00000000-0000-0000-0000-000000000030",
    "State": "Completed",
    "Type": "PartitionRestart"
  },
  {
    "OperationId": "00000000-0000-0000-0000-000000000500",
    "State": "Faulted",
    "Type": "NodeTransition"
  },
  {
    "OperationId": "00000000-0000-0000-0000-000000000700",
    "State": "Completed",
    "Type": "NodeTransition"
  },
  {
    "OperationId": "00000000-0000-0000-0000-000000000710",
    "State": "Completed",
    "Type": "NodeTransition"
  },
  {
    "OperationId": "88ef90f9-0b94-46b0-b817-a6ea20c07f8a",
    "State": "Completed",
    "Type": "PartitionRestart"
  }
]