Sign in

v10

latestSwagger 2.02026-07-132477431.2 MB
BackupRestore

Gets a particular backup policy by name.

Gets a particular backup policy identified by {backupPolicyName}

get/BackupRestore/BackupPolicies/{backupPolicyName}

Path parameters

backupPolicyNamestring required

The name of the backup policy.

Query parameters

api-version'6.4' required

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.

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

A successful operation will return 200 status code and the backup policy description.

Namestring required

The unique name identifying this backup policy.

AutoRestoreOnDataLossboolean required

Specifies whether to trigger restore automatically using the latest available backup in case the partition experiences a data loss event.

MaxIncrementalBackupsinteger required

Defines the maximum number of incremental backups to be taken between two full backups. This is just the upper limit. A full backup may be taken before specified number of incremental backups are completed in one of the following conditions

  • The replica has never taken a full backup since it has become primary,
  • Some of the log records since the last backup has been truncated, or
  • Replica passed the MaxAccumulatedBackupLogSizeInMB limit.