Freigeben über

Abrufen der Sicherungsrichtlinienliste

  • Artikel

Ruft alle konfigurierten Sicherungsrichtlinien ab.

Rufen Sie eine Liste aller konfigurierten Sicherungsrichtlinien ab.

Anforderung

Methode Anforderungs-URI
GET /BackupRestore/BackupPolicies?api-version=6.4&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parameter

Name type Erforderlich Standort
api-version Zeichenfolge Ja Abfrage
ContinuationToken Zeichenfolge Nein Abfrage
MaxResults ganze Zahl (int64) Nein Abfrage
timeout ganze Zahl (int64) Nein Abfrage

api-version

Typ: Zeichenfolge
Erforderlich: Ja
Standard:

Die Version der API. Dieser Parameter ist erforderlich, und sein Wert muss "6.4" sein.

Die Rest-API-Version von Service Fabric basiert auf der Laufzeitversion, in der die API eingeführt oder geändert wurde. Die Service Fabric-Runtime unterstützt mehrere Versionen der API. Diese Version ist die neueste unterstützte Version der API. Wenn eine niedrigere API-Version übergeben wird, unterscheidet sich die zurückgegebene Antwort möglicherweise von der in dieser Spezifikation dokumentierten.

Darüber hinaus akzeptiert die Runtime jede Version, die höher als die neueste unterstützte Version bis zur aktuellen Version der Runtime ist. Wenn also die neueste API-Version 6.0 und die Runtime 6.1 ist, akzeptiert die Runtime Version 6.1 für diese API. Das Verhalten der API entspricht jedoch der dokumentierten Version 6.0.

ContinuationToken

Typ: Zeichenfolge
Erforderlich: Nein

Der Parameter „continuation-token“ (Fortsetzungstoken) wird dazu verwendet, den nächsten Satz von Ergebnissen abzurufen. Ein Fortsetzungstoken mit einem nicht leeren Wert wird in die Antwort der API eingefügt, wenn die Ergebnisse aus dem System nicht in eine einzige Antwort passen. Wird dieser Wert an den nächsten API-Aufruf übergeben, gibt die API den nächsten Satz von Ergebnissen zurück. Gibt es keine weiteren Ergebnisse, enthält das Fortsetzungstoken keinen Wert. Der Wert dieses Parameters darf nicht als URL codiert sein.

MaxResults

Typ: integer (int64)
Erforderlich: Nein
Standard:
InklusiveMinimum: 0

Die maximale Anzahl von Ergebnissen, die als Teil der seitenweisen Abfragen zurückgegeben werden sollen. Dieser Parameter definiert die obere Grenze für die Anzahl von zurückgegebenen Ergebnissen. Es können weniger Ergebnisse zurückgegeben werden, als dieser maximalen Anzahl entspricht. Dies ist der Fall, wenn die Ergebnisse wegen der Größenbeschränkungen, die für Meldungen in der Konfiguration definiert sind, nicht in die jeweilige Meldung passen. Ist dieser Parameter gleich null oder nicht angegeben, enthält die seitenweise Abfrage so viele Ergebnisse, wie in die Rückgabemeldung passen.

timeout

Typ: integer (int64)
Erforderlich: Nein
Standard:
InclusiveMaximum: 4294967295
InklusiveMinimum: 1

Der Servertimeout für die Ausführung des Vorgangs in Sekunden. Dieser Timeout gibt die Zeitdauer an, die der Client bereit ist, auf den Abschluss des angeforderten Vorgangs zu warten. Der Standardwert für diesen Parameter ist 60 Sekunden.

Antworten

HTTP-Statuscode BESCHREIBUNG Antwortschema
200 (OK) Bei einem erfolgreichen Vorgang werden 200 status Code und eine ausgelagerte Liste von Sicherungsrichtlinien zurückgegeben.
 PagedBackupPolicyDescriptionList
Alle anderen status Codes Die detaillierte Fehlerantwort.
 FabricError

Beispiele

Begrenzen der maximalen Ergebnisse

In diesem Beispiel wird gezeigt, wie Sie eine Liste der Sicherungsrichtlinien abrufen. Die Anzahl der Ergebnisse auf einer Seite ist mit dem MaxResult-Parameter auf maximal vier beschränkt.

Anforderung

GET http://localhost:19080/BackupRestore/BackupPolicies?api-version=6.4&MaxResults=4

Antwort 200

Text
{
  "ContinuationToken": "FileShare10MinBackupPolicy",
  "Items": [
    {
      "Name": "DailyAzureBackupPolicy",
      "AutoRestoreOnDataLoss": false,
      "MaxIncrementalBackups": "3",
      "Schedule": {
        "ScheduleKind": "TimeBased",
        "ScheduleFrequencyType": "Daily",
        "RunTimes": [
          "0001-01-01T09:00:00Z",
          "0001-01-01T17:00:00Z"
        ]
      },
      "Storage": {
        "StorageKind": "AzureBlobStore",
        "FriendlyName": "Azure_storagesample",
        "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<PutYourAccountKeyHere>",
        "ContainerName": "BackupContainer"
      },
      "RetentionPolicy": {
        "RetentionPolicyType": "Basic",
        "MinimumNumberOfBackups": "30",
        "RetentionDuration": "P29D"
      }
    },
    {
      "Name": "DailyAzureMIBackupPolicy",
      "AutoRestoreOnDataLoss": false,
      "MaxIncrementalBackups": "3",
      "Schedule": {
        "ScheduleKind": "TimeBased",
        "ScheduleFrequencyType": "Daily",
        "RunTimes": [
          "0001-01-01T09:00:00Z",
          "0001-01-01T17:00:00Z"
        ]
      },
      "Storage": {
        "StorageKind": "ManagedIdentityAzureBlobStore",
        "FriendlyName": "AzureMI_storagesample",
        "BlobServiceUri": "https://managedidentitytest.blob.core.windows.net/",
        "ContainerName": "BackupContainer",
        "ManagedIdentityType": "Cluster"
      },
      "RetentionPolicy": {
        "RetentionPolicyType": "Basic",
        "MinimumNumberOfBackups": "30",
        "RetentionDuration": "P29D"
      }
    },
    {
      "Name": "SampleDsmsBackupPolicy",
      "AutoRestoreOnDataLoss": false,
      "MaxIncrementalBackups": "3",
      "Schedule": {
        "ScheduleKind": "TimeBased",
        "ScheduleFrequencyType": "Daily",
        "RunTimes": [
          "0001-01-01T09:00:00Z",
          "0001-01-01T17:00:00Z"
        ]
      },
      "Storage": {
        "StorageKind": "DsmsAzureBlobStore",
        "FriendlyName": "DsmsAzure_storagesample",
        "StorageCredentialsSourceLocation": "https://sample-dsms.dsms.core.winows.net/dsms/samplecredentiallocation/storageaccounts/samplestorageac/servicefabricbackup/samplebackup",
        "ContainerName": "BackupContainer"
      },
      "RetentionPolicy": {
        "RetentionPolicyType": "Basic",
        "MinimumNumberOfBackups": "10",
        "RetentionDuration": "P3M"
      }
    },
    {
      "Name": "FileShare10MinBackupPolicy",
      "AutoRestoreOnDataLoss": false,
      "MaxIncrementalBackups": "3",
      "Schedule": {
        "ScheduleKind": "FrequencyBased",
        "Interval": "PT10M"
      },
      "Storage": {
        "StorageKind": "FileShare",
        "FriendlyName": "FileShare_myshare",
        "Path": "\\\\myshare\\backupshare",
        "PrimaryUserName": "backupaccount",
        "PrimaryPassword": "****"
      },
      "RetentionPolicy": {
        "RetentionPolicyType": "Basic",
        "MinimumNumberOfBackups": "20",
        "RetentionDuration": "P20D"
      }
    }
  ]
}

Seite mit Fortsetzungstoken

In diesem Beispiel wird gezeigt, wie Sie eine Liste der Sicherungsrichtlinien abrufen. Die Anzahl der Ergebnisse auf einer Seite ist mit dem MaxResult-Parameter auf maximal drei beschränkt. In diesem Beispiel wird der ContinuationToken-Parameter verwendet. Der Wert dieses Parameters wird aus der vorherigen Abfrage bereitgestellt. in diesem Fall das oben gezeigte Beispiel. Die Antwort enthält die verbleibenden Ergebnisse und ein leeres ContinuationToken. Das leere ContinuationToken gibt an, dass keine zusätzlichen Ergebnisse verfügbar sind.

Anforderung

GET http://localhost:19080/BackupRestore/BackupPolicies?api-version=6.4&ContinuationToken=FileShare10MinBackupPolicy&MaxResults=3

Antwort 200

Text
{
  "ContinuationToken": "",
  "Items": [
    {
      "AutoRestoreOnDataLoss": false,
      "Name": "SampleBackupPolicy",
      "MaxIncrementalBackups": "5",
      "Schedule": {
        "ScheduleKind": "FrequencyBased",
        "Interval": "PT4H5M"
      },
      "Storage": {
        "Path": "\\\\myshare\\BackupStore",
        "PrimaryUserName": "myuser1",
        "PrimaryPassword": "****",
        "SecondaryUserName": "myuser2",
        "SecondaryPassword": "****",
        "StorageKind": "FileShare",
        "FriendlyName": ""
      },
      "RetentionPolicy": {
        "RetentionPolicyType": "Basic",
        "MinimumNumberOfBackups": "0",
        "RetentionDuration": "P20D"
      }
    }
  ]
}