--- title: "Gets the list of backups available for the specified partition." method: GET path: "/Partitions/{partitionId}/$/GetBackups" tags: ["BackupRestore"] --- # Gets the list of backups available for the specified partition. `GET /Partitions/{partitionId}/$/GetBackups` Returns a list of backups available for the specified partition. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for the partition. ## Path parameters - `partitionId` string, uuid, required ## Query parameters - `api-version` '6.4', required - `timeout` integer - `Latest` boolean - `StartDateTimeFilter` string, date-time - `EndDateTimeFilter` string, date-time ## Response `200` A successful operation will return 200 status code and a paged list of backup information. - PagedBackupInfoList — The list of backups. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list. - `ContinuationToken` string — The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response. - `Items` BackupInfo[] — List of backup information. - `BackupId` string, uuid — Unique backup ID . - `BackupChainId` string, uuid — Unique backup chain ID. All backups part of the same chain has the same backup chain id. A backup chain is comprised of 1 full backup and multiple incremental backups. - `ApplicationName` string — Name of the Service Fabric application this partition backup belongs to. - `ServiceName` string — Name of the Service Fabric service this partition backup belongs to. - `PartitionInformation` PartitionInformation — Information about the partition identity, partitioning scheme and keys supported by it. - `ServicePartitionKind` 'Invalid' | 'Singleton' | 'Int64Range' | 'Named', required — The kind of partitioning scheme used to partition the service. - `Id` string, uuid — An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different. - `BackupLocation` string — Location of the backup, relative to the backup store. - `BackupType` 'Invalid' | 'Full' | 'Incremental' — Describes the type of backup, whether its full or incremental. - `EpochOfLastBackupRecord` Epoch — An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica. - `ConfigurationVersion` string — The current configuration number of this Epoch. The configuration number is an increasing value that is updated whenever the configuration of this replica set changes. - `DataLossVersion` string — The current data loss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica. - `LsnOfLastBackupRecord` string — LSN of the last record in this backup. - `CreationTimeUtc` string, date-time — The date time when this backup was taken. - `ServiceManifestVersion` string — Manifest Version of the service this partition backup belongs to. - `FailureError` FabricErrorError — Error object containing error code and error message. - `Code` 'FABRIC_E_INVALID_PARTITION_KEY' | 'FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR' | 'FABRIC_E_INVALID_ADDRESS' | 'FABRIC_E_APPLICATION_NOT_UPGRADING' | 'FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR' | 'FABRIC_E_FABRIC_NOT_UPGRADING' | 'FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR' | 'FABRIC_E_INVALID_CONFIGURATION' | 'FABRIC_E_INVALID_NAME_URI' | 'FABRIC_E_PATH_TOO_LONG' | 'FABRIC_E_KEY_TOO_LARGE' | 'FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED' | 'FABRIC_E_INVALID_ATOMIC_GROUP' | 'FABRIC_E_VALUE_EMPTY' | 'FABRIC_E_NODE_NOT_FOUND' | 'FABRIC_E_APPLICATION_TYPE_NOT_FOUND' | 'FABRIC_E_APPLICATION_NOT_FOUND' | 'FABRIC_E_SERVICE_TYPE_NOT_FOUND' | 'FABRIC_E_SERVICE_DOES_NOT_EXIST' | 'FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND' | 'FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND' | 'FABRIC_E_PARTITION_NOT_FOUND' | 'FABRIC_E_REPLICA_DOES_NOT_EXIST' | 'FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST' | 'FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND' | 'FABRIC_E_DIRECTORY_NOT_FOUND' | 'FABRIC_E_FABRIC_VERSION_NOT_FOUND' | 'FABRIC_E_FILE_NOT_FOUND' | 'FABRIC_E_NAME_DOES_NOT_EXIST' | 'FABRIC_E_PROPERTY_DOES_NOT_EXIST' | 'FABRIC_E_ENUMERATION_COMPLETED' | 'FABRIC_E_SERVICE_MANIFEST_NOT_FOUND' | 'FABRIC_E_KEY_NOT_FOUND' | 'FABRIC_E_HEALTH_ENTITY_NOT_FOUND' | 'FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS' | 'FABRIC_E_APPLICATION_ALREADY_EXISTS' | 'FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION' | 'FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS' | 'FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS' | 'FABRIC_E_SERVICE_ALREADY_EXISTS' | 'FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS' | 'FABRIC_E_APPLICATION_TYPE_IN_USE' | 'FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION' | 'FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS' | 'FABRIC_E_FABRIC_VERSION_IN_USE' | 'FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS' | 'FABRIC_E_NAME_ALREADY_EXISTS' | 'FABRIC_E_NAME_NOT_EMPTY' | 'FABRIC_E_PROPERTY_CHECK_FAILED' | 'FABRIC_E_SERVICE_METADATA_MISMATCH' | 'FABRIC_E_SERVICE_TYPE_MISMATCH' | 'FABRIC_E_HEALTH_STALE_REPORT' | 'FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED' | 'FABRIC_E_NODE_HAS_NOT_STOPPED_YET' | 'FABRIC_E_INSTANCE_ID_MISMATCH' | 'FABRIC_E_VALUE_TOO_LARGE' | 'FABRIC_E_NO_WRITE_QUORUM' | 'FABRIC_E_NOT_PRIMARY' | 'FABRIC_E_NOT_READY' | 'FABRIC_E_RECONFIGURATION_PENDING' | 'FABRIC_E_SERVICE_OFFLINE' | 'E_ABORT' | 'FABRIC_E_COMMUNICATION_ERROR' | 'FABRIC_E_OPERATION_NOT_COMPLETE' | 'FABRIC_E_TIMEOUT' | 'FABRIC_E_NODE_IS_UP' | 'E_FAIL' | 'FABRIC_E_BACKUP_IS_ENABLED' | 'FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH' | 'FABRIC_E_INVALID_FOR_STATELESS_SERVICES' | 'FABRIC_E_BACKUP_NOT_ENABLED' | 'FABRIC_E_BACKUP_POLICY_NOT_EXISTING' | 'FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING' | 'FABRIC_E_BACKUP_IN_PROGRESS' | 'FABRIC_E_RESTORE_IN_PROGRESS' | 'FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING' | 'FABRIC_E_INVALID_SERVICE_SCALING_POLICY' | 'E_INVALIDARG' | 'FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS' | 'FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND' | 'FABRIC_E_VOLUME_ALREADY_EXISTS' | 'FABRIC_E_VOLUME_NOT_FOUND' | 'SerializationError' | 'FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR', required — Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code. - Possible values of the error code for HTTP status code 400 (Bad Request) - "FABRIC_E_INVALID_PARTITION_KEY" - "FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR" - "FABRIC_E_INVALID_ADDRESS" - "FABRIC_E_APPLICATION_NOT_UPGRADING" - "FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR" - "FABRIC_E_FABRIC_NOT_UPGRADING" - "FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR" - "FABRIC_E_INVALID_CONFIGURATION" - "FABRIC_E_INVALID_NAME_URI" - "FABRIC_E_PATH_TOO_LONG" - "FABRIC_E_KEY_TOO_LARGE" - "FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED" - "FABRIC_E_INVALID_ATOMIC_GROUP" - "FABRIC_E_VALUE_EMPTY" - "FABRIC_E_BACKUP_IS_ENABLED" - "FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH" - "FABRIC_E_INVALID_FOR_STATELESS_SERVICES" - "FABRIC_E_INVALID_SERVICE_SCALING_POLICY" - "E_INVALIDARG" - Possible values of the error code for HTTP status code 404 (Not Found) - "FABRIC_E_NODE_NOT_FOUND" - "FABRIC_E_APPLICATION_TYPE_NOT_FOUND" - "FABRIC_E_APPLICATION_NOT_FOUND" - "FABRIC_E_SERVICE_TYPE_NOT_FOUND" - "FABRIC_E_SERVICE_DOES_NOT_EXIST" - "FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND" - "FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND" - "FABRIC_E_PARTITION_NOT_FOUND" - "FABRIC_E_REPLICA_DOES_NOT_EXIST" - "FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST" - "FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND" - "FABRIC_E_DIRECTORY_NOT_FOUND" - "FABRIC_E_FABRIC_VERSION_NOT_FOUND" - "FABRIC_E_FILE_NOT_FOUND" - "FABRIC_E_NAME_DOES_NOT_EXIST" - "FABRIC_E_PROPERTY_DOES_NOT_EXIST" - "FABRIC_E_ENUMERATION_COMPLETED" - "FABRIC_E_SERVICE_MANIFEST_NOT_FOUND" - "FABRIC_E_KEY_NOT_FOUND" - "FABRIC_E_HEALTH_ENTITY_NOT_FOUND" - "FABRIC_E_BACKUP_NOT_ENABLED" - "FABRIC_E_BACKUP_POLICY_NOT_EXISTING" - "FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING" - "FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR" - Possible values of the error code for HTTP status code 409 (Conflict) - "FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS" - "FABRIC_E_APPLICATION_ALREADY_EXISTS" - "FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION" - "FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS" - "FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS" - "FABRIC_E_SERVICE_ALREADY_EXISTS" - "FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS" - "FABRIC_E_APPLICATION_TYPE_IN_USE" - "FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION" - "FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS" - "FABRIC_E_FABRIC_VERSION_IN_USE" - "FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS" - "FABRIC_E_NAME_ALREADY_EXISTS" - "FABRIC_E_NAME_NOT_EMPTY" - "FABRIC_E_PROPERTY_CHECK_FAILED" - "FABRIC_E_SERVICE_METADATA_MISMATCH" - "FABRIC_E_SERVICE_TYPE_MISMATCH" - "FABRIC_E_HEALTH_STALE_REPORT" - "FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED" - "FABRIC_E_NODE_HAS_NOT_STOPPED_YET" - "FABRIC_E_INSTANCE_ID_MISMATCH" - "FABRIC_E_BACKUP_IN_PROGRESS" - "FABRIC_E_RESTORE_IN_PROGRESS" - "FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING" - Possible values of the error code for HTTP status code 413 (Request Entity Too Large) - "FABRIC_E_VALUE_TOO_LARGE" - Possible values of the error code for HTTP status code 500 (Internal Server Error) - "FABRIC_E_NODE_IS_UP" - "E_FAIL" - "FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS" - "FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND" - "FABRIC_E_VOLUME_ALREADY_EXISTS" - "FABRIC_E_VOLUME_NOT_FOUND" - "SerializationError" - Possible values of the error code for HTTP status code 503 (Service Unavailable) - "FABRIC_E_NO_WRITE_QUORUM" - "FABRIC_E_NOT_PRIMARY" - "FABRIC_E_NOT_READY" - "FABRIC_E_RECONFIGURATION_PENDING" - "FABRIC_E_SERVICE_OFFLINE" - "E_ABORT" - "FABRIC_E_VALUE_TOO_LARGE" - Possible values of the error code for HTTP status code 504 (Gateway Timeout) - "FABRIC_E_COMMUNICATION_ERROR" - "FABRIC_E_OPERATION_NOT_COMPLETE" - "FABRIC_E_TIMEOUT" - `Message` string — Error message. ## Other responses - `default` — The detailed error response. --- [API](https://skmtc.net/azure/apis/service-fabric-client-apis.md) · [All operations](https://skmtc.net/azure/apis/service-fabric-client-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/service-fabric-client-apis/versions/6df9f2f4d542/schema)