v2

latestSwagger 2.0raw.githubusercontent.com2019-06-202346811.1 MB
Faults

Gets the progress of a partition data loss operation started using the StartDataLoss API.

Gets the progress of a data loss operation started with StartDataLoss, using the OperationId.

get/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetDataLossProgress

Path parameters

serviceIdstring required

The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myappapp1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.

partitionIdstring uuid required

The identity of the partition.

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.

OperationIdstring uuid required

A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API

timeoutinteger

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.

Response

Information about the progress of the partition data loss operation.

State'Invalid' | 'Running' | 'RollingBack' | 'Completed' | 'Faulted' | 'Cancelled' | 'ForceCancelled'

The state of the operation.