Restore Partition
Triggers restore of the state of the partition using the specified restore partition description.
Restores the state of a of the stateful persisted partition using the specified backup point. In case the partition is already being periodically backed up, then by default the backup point is looked for in the storage specified in backup policy. One can also override the same by specifying the backup storage details as part of the restore partition description in body. Once the restore is initiated, its progress can be tracked using the GetRestoreProgress operation. In case, the operation times out, specify a greater restore timeout value in the query parameter.
Request
| Method | Request URI |
|---|---|
| POST | /Partitions/{partitionId}/$/Restore?RestoreTimeout={RestoreTimeout}&api-version=6.4&timeout={timeout} |
Parameters
| Name | Type | Required | Location |
|---|---|---|---|
partitionId |
string (uuid) | Yes | Path |
RestoreTimeout |
integer | No | Query |
api-version |
string | Yes | Query |
timeout |
integer (int64) | No | Query |
RestorePartitionDescription |
RestorePartitionDescription | Yes | Body |
partitionId
Type: string (uuid)
Required: Yes
The identity of the partition.
RestoreTimeout
Type: integer
Required: No
Default: 10
Specifies the maximum amount of time to wait, in minutes, for the restore operation to complete. Post that, the operation returns back with timeout error. However, in certain corner cases it could be that the restore operation goes through even though it completes with timeout. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. the default value for the same is 10 minutes.
api-version
Type: string
Required: Yes
Default: 6.4
The version of the API. This parameter is required and its value must be '6.4'.
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 version 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 accepts 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 and the runtime is 6.1, 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.
RestorePartitionDescription
Type: RestorePartitionDescription
Required: Yes
Describes the parameters to restore the partition.
Responses
| HTTP Status Code | Description | Response Schema |
|---|---|---|
| 202 (Accepted) | A 202 status code indicates the operation request was accepted and restore will be initiated. Use GetPartitionRestoreProgress operation to get the status of the restore operation. |
|
| All other status codes | The detailed error response. |
FabricError |
Examples
Trigger partition restore
This example shows how to trigger restore of a partition now by specifying the backup to be used to restore.
Request
POST http://localhost:19080/Partitions/1daae3f5-7fd6-42e9-b1ba-8c05f873994d/$/Restore?api-version=6.4
Body
{
"BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba",
"BackupStorage": {
"StorageKind": "AzureBlobStore",
"ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<PutYourAccountKeyHere>",
"ContainerName": "BackupContainer"
},
"BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip"
}
202 Response
Body
The response body is empty.