Start Partition Restart
This API will restart some or all replicas or instances of the specified partition.
This API is useful for testing failover.
If used to target a stateless service partition, RestartPartitionMode must be AllReplicasOrInstances.
Call the GetPartitionRestartProgress API using the same OperationId to get the progress.
Request
| Method | Request URI |
|---|---|
| POST | /Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartRestart?api-version=6.0&OperationId={OperationId}&RestartPartitionMode={RestartPartitionMode}&timeout={timeout} |
Parameters
| Name | Type | Required | Location |
|---|---|---|---|
serviceId |
string | Yes | Path |
partitionId |
string (uuid) | Yes | Path |
api-version |
string | Yes | Query |
OperationId |
string (uuid) | Yes | Query |
RestartPartitionMode |
string (enum) | Yes | Query |
timeout |
integer (int64) | No | Query |
serviceId
Type: string
Required: Yes
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 "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.
partitionId
Type: string (uuid)
Required: Yes
The identity of the partition.
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.
OperationId
Type: string (uuid)
Required: Yes
A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API
RestartPartitionMode
Type: string (enum)
Required: Yes
Describe which partitions to restart. Possible values include: 'Invalid', 'AllReplicasOrInstances', 'OnlyActiveSecondaries'
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 |
|---|---|---|
| 202 (Accepted) | A 202 status code indicates the operation was accepted. Call the GetPartitionRestartProgress API to get the progress. |
|
| All other status codes | The detailed error response. |
FabricError |