Получение списка политик резервного копирования

Возвращает все настроенные политики резервного копирования.

Получите список всех настроенных политик резервного копирования.

Запрос

Метод	Универсальный код ресурса (URI) запроса
GET	/BackupRestore/BackupPolicies?api-version=6.4&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Параметры

Имя	Тип	Обязательно	Расположение
api-version	строка	Да	Запрос
ContinuationToken	строка	Нет	Запрос
MaxResults	integer (int64)	Нет	Запрос
timeout	integer (int64)	Нет	Запрос

---

api-version

Тип: string
Обязательный: да
По умолчанию: 6.4

Версия API. Этот параметр является обязательным и его значение должно быть "6,4".

Версия REST API Service Fabric основана на версии среды выполнения, в которой api был представлен или был изменен. Среда выполнения Service Fabric поддерживает несколько версий API. Эта версия является последней поддерживаемой версией API. Если передается более ранжная версия API, возвращаемый ответ может отличаться от ответа, описанного в этой спецификации.

Кроме того, среда выполнения принимает любую версию, которая выше последней поддерживаемой версии, вплоть до текущей версии среды выполнения. Поэтому если последняя версия API — 6.0, а среда выполнения — 6.1, среда выполнения будет принимать версию 6.1 для этого API. Однако поведение API будет выполняться в документе версии 6.0.

---

ContinuationToken

Тип: string
Обязательный: нет

Параметр маркера продолжения используется для получения следующего набора результатов. Маркер продолжения с непустым значением добавляется в ответ API, когда результаты из системы не помещаются в один ответ. Когда это значение передается в следующем вызове API, API возвращает следующий набор результатов. Если результаты отсутствуют, маркер продолжения не будет содержать значение. Значение этого параметра не должно быть указано в формате URL-адреса.

---

MaxResults

Тип: integer (int64)
Обязательный: нет
По умолчанию: 0
InclusiveMinimum: 0

Максимальное количество результатов, возвращаемых в результате страничного запроса. Этот параметр определяет максимальное число возвращаемых результатов. Возвращаемых результатов может быть меньше, чем указанное максимальное количество результатов, если они не помещаются в сообщении согласно ограничениям максимального размера сообщения, определенным в конфигурации. Если этот параметр равен нулю или не указан, то результат страничного запроса содержит максимальное число результатов, помещающееся в возвращаемом сообщении.

---

timeout

Тип: integer (int64)
Обязательный: нет
По умолчанию: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд.

Ответы

Код состояния HTTP	Описание	схеме ответа.
200 OK;	После успешной операции возвращается код состояния 200 и выстраивный список политик резервного копирования.	PagedBackupPolicyDescriptionList
Все остальные коды состояния	Подробный ответ об ошибке.	FabricError

Примеры

Ограничение максимального количества результатов

В этом примере показано, как получить список политик резервного копирования. Количество результатов на странице ограничено максимум четырьмя с помощью параметра MaxResult.

Запрос

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

Ответ 200

Текст

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

Страница с использованием маркера продолжения

В этом примере показано, как получить список политик резервного копирования. Количество результатов на странице ограничено максимум тремя с помощью параметра MaxResult. В этом примере используется параметр ContinuationToken. Значение этого параметра предоставляется из предыдущего запроса; в этом случае в примере, показанном выше. Ответ содержит оставшиеся результаты и пустой элемент ContinuationToken. Пустой элемент ContinuationToken указывает, что дополнительные результаты недоступны.

Запрос

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

Ответ 200

Текст

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