Back-upbeleidslijst ophalen

  • Artikel

Hiermee haalt u alle geconfigureerde back-upbeleidsregels op.

Haal een lijst op met alle geconfigureerde back-upbeleidsregels.

Aanvraag

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

Parameters

Naam Type Vereist Locatie
api-version tekenreeks Ja Query’s uitvoeren
ContinuationToken tekenreeks No Query’s uitvoeren
MaxResults geheel getal (int64) Nee Query’s uitvoeren
timeout geheel getal (int64) Nee Query’s uitvoeren

api-version

Type: tekenreeks
Vereist: Ja
Standaardinstelling: 6.4

De versie van de API. Deze parameter is vereist en de waarde moet '6.4' zijn.

Service Fabric REST API-versie is gebaseerd op de runtimeversie waarin de API is geïntroduceerd of is gewijzigd. Service Fabric-runtime ondersteunt meer dan één versie van de API. Deze versie is de meest recente ondersteunde versie van de API. Als een lagere API-versie wordt doorgegeven, kan het geretourneerde antwoord afwijken van het antwoord dat in deze specificatie wordt beschreven.

Bovendien accepteert de runtime elke versie die hoger is dan de meest recente ondersteunde versie tot de huidige versie van de runtime. Dus als de nieuwste API-versie 6.0 is en de runtime 6.1 is, accepteert de runtime versie 6.1 voor die API. Het gedrag van de API is echter volgens de gedocumenteerde versie 6.0.

ContinuationToken

Type: tekenreeks
Vereist: Nee

De parameter voor het vervolgtoken wordt gebruikt om de volgende set resultaten te verkrijgen. Een vervolgtoken met een niet-lege waarde wordt opgenomen in het antwoord van de API wanneer de resultaten van het systeem niet in één antwoord passen. Wanneer deze waarde wordt doorgegeven aan de volgende API-aanroep, retourneert de API de volgende set resultaten. Als er geen verdere resultaten zijn, bevat het vervolgtoken geen waarde. De waarde van deze parameter mag geen URL-codering hebben.

MaxResults

Type: geheel getal (int64)
Vereist: Nee
Standaardinstelling: 0
InclusiefMinimum: 0

Het maximum aantal resultaten dat moet worden geretourneerd als onderdeel van de gepaginade query's. Deze parameter definieert de bovengrens voor het aantal geretourneerde resultaten. De geretourneerde resultaten kunnen kleiner zijn dan de opgegeven maximumresultaten als ze niet in het bericht passen volgens de beperkingen voor de maximale berichtgrootte die in de configuratie zijn gedefinieerd. Als deze parameter nul is of niet is opgegeven, bevat de gepaginade query zoveel mogelijk resultaten die in het retourbericht passen.

timeout

Type: geheel getal (int64)
Vereist: Nee
Standaardinstelling: 60
InclusiefMaximum: 4294967295
InclusiefMinimum: 1

De servertime-out voor het uitvoeren van de bewerking in seconden. Deze time-out geeft de tijdsduur aan die de client bereid is te wachten tot de aangevraagde bewerking is voltooid. De standaardwaarde voor deze parameter is 60 seconden.

Antwoorden

HTTP-statuscode Beschrijving Antwoordschema
200 (OK) Een geslaagde bewerking retourneert 200 statuscode en een paginalijst met back-upbeleidsregels.
 PagedBackupPolicyDescriptionList
Alle andere statuscodes Het gedetailleerde foutantwoord.
 FabricError

Voorbeelden

Maximum aantal resultaten beperken

In dit voorbeeld ziet u hoe u een lijst met back-upbeleidsregels kunt ophalen. Het aantal resultaten op een pagina is beperkt tot maximaal vier met behulp van de parameter MaxResult.

Aanvraag

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

200-antwoord

Hoofdtekst
{
  "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"
      }
    }
  ]
}

Pagina met vervolgtoken

In dit voorbeeld ziet u hoe u een lijst met back-upbeleidsregels kunt ophalen. Het aantal resultaten op een pagina is beperkt tot maximaal drie met behulp van de parameter MaxResult. In dit voorbeeld wordt de parameter ContinuationToken gebruikt. De waarde van deze parameter wordt opgegeven uit de vorige query; in dit geval het bovenstaande voorbeeld. Het antwoord bevat de resterende resultaten en een leeg ContinuationToken. Het lege ContinuationToken geeft aan dat er geen aanvullende resultaten beschikbaar zijn.

Aanvraag

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

200-antwoord

Hoofdtekst
{
  "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"
      }
    }
  ]
}