Ottenere l'elenco dei criteri di backup

Ottiene tutti i criteri di backup configurati.

Ottenere un elenco di tutti i criteri di backup configurati.

Richiesta

Parametri

api-version

Tipo: stringa
Obbligatorio: Sì
Impostazione predefinita: 6.4

Versione dell'API. Questo parametro è obbligatorio e il relativo valore deve essere '6.4'.

La versione dell'API REST di Service Fabric è basata sulla versione di runtime in cui è stata introdotta o modificata l'API. Il runtime di Service Fabric supporta più versioni dell'API. Questa versione è la versione più recente supportata dell'API. Se viene passata una versione api inferiore, la risposta restituita può essere diversa da quella documentata in questa specifica.

Inoltre, il runtime accetta qualsiasi versione superiore alla versione supportata più recente fino alla versione corrente del runtime. Quindi, se la versione più recente dell'API è 6.0 e il runtime è 6.1, il runtime accetterà la versione 6.1 per tale API. Tuttavia, il comportamento dell'API sarà in base alla versione 6.0 documentata.

ContinuationToken

Tipo: stringa
Obbligatorio: No

Il parametro del token di continuazione viene utilizzato per ottenere il set di risultati successivo. Un token di continuazione con un valore non vuoto è incluso nella risposta dell'API quando i risultati del sistema non rientrano in una singola risposta. Quando questo valore viene passato alla successiva chiamata API, l'API restituisce il set di risultati successivo. Se non sono presenti altri risultati, il token di continuazione non contiene alcun valore. Il valore di questo parametro non deve essere codificato in URL.

MaxResults

Tipo: integer (int64)
Obbligatorio: No
Impostazione predefinita: 0
InclusiveMinimum: 0

Il numero massimo di risultati che devono essere restituiti come parte delle query di paging. Questo parametro definisce il limite massimo di risultati restituiti. Se non rientrano nel messaggio in base ai limiti di dimensione massima per i messaggi definiti nella configurazione, il numero dei risultati restituiti può essere inferiore al numero massimo di risultati specificato. Se questo parametro è uguale a zero o non specificato, le query di paging includono il numero massimo di risultati possibili che rientrano nel messaggio restituito.

timeout

Tipo: integer (int64)
Obbligatorio: No
Impostazione predefinita: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Timeout del server per l'esecuzione dell'operazione in secondi. Questo timeout specifica la durata del tempo che il client è disposto a attendere il completamento dell'operazione richiesta. Il valore predefinito per questo parametro è 60 secondi.

Risposte

Esempio

Limitare i risultati massimi

In questo esempio viene illustrato come ottenere l'elenco dei criteri di backup. Il numero di risultati in una pagina è limitato a un massimo di quattro usando il parametro MaxResult.

Richiesta

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

Risposta 200

Corpo

{
  "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 con token di continuazione

In questo esempio viene illustrato come ottenere l'elenco dei criteri di backup. Il numero di risultati in una pagina è limitato al massimo di tre usando il parametro MaxResult. In questo esempio viene usato il parametro ContinuationToken. Il valore di questo parametro viene fornito dalla query precedente; in questo caso l'esempio illustrato sopra. La risposta contiene i risultati rimanenti e una continuazione vuotaToken. La continuazione vuotaToken indica che non sono disponibili risultati aggiuntivi.

Richiesta

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

Risposta 200

Corpo

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