Restart Replica

  • Article

Restarts a service replica of a persisted service running on a node.

Restarts a service replica of a persisted service running on a node. Warning - There are no safety checks performed when this API is used. Incorrect use of this API can lead to availability loss for stateful services.

Request

Method Request URI
POST /Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Restart?api-version=6.0&timeout={timeout}

Parameters

Name Type Required Location
nodeName string Yes Path
partitionId string (uuid) Yes Path
replicaId string Yes Path
api-version string Yes Query
timeout integer (int64) No Query

nodeName

Type: string
Required: Yes

The name of the node.

partitionId

Type: string (uuid)
Required: Yes

The identity of the partition.

replicaId

Type: string
Required: Yes

The identifier of the replica.

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.

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. A successful operation means that the restart command was received by the replica on the node and it is in the process of restarting.
All other status codes The detailed error response.
 FabricError