Поделиться через

Получение сведений о конфигурации резервного копирования приложений

  • Статья

Возвращает сведения о конфигурации резервного копирования приложения Service Fabric.

Возвращает сведения о конфигурации резервного копирования Service Fabric для приложения, а также служб и секций в этом приложении.

Запрос

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

Параметры

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

applicationId

Тип: строка
Обязательный: да

Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1".

api-version

Тип: строка
Обязательный: да
По умолчанию: 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

Тип: строка
Обязательный: нет

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

MaxResults

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

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

timeout

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

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

Ответы

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

Примеры

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

В этом примере показано, как получить список конфигурации резервного копирования для этого приложения и сущностей (служб и секций) в этом приложении. Количество результатов на странице ограничено максимум двумя с помощью параметра MaxResult.

Запрос

GET http://localhost:19080/Applications/CalcApp/$/GetBackupConfigurationInfo?api-version=6.4&MaxResults=2

Ответ 200

Текст
{
  "ContinuationToken": "fabric:/CalcApp/CalcService",
  "Items": [
    {
      "Kind": "Application",
      "PolicyName": "BackupPolicy1",
      "PolicyInheritedFrom": "Application",
      "ApplicationName": "fabric:/CalcApp",
      "SuspensionInfo": {
        "IsSuspended": false,
        "SuspensionInheritedFrom": "Invalid"
      }
    },
    {
      "Kind": "Service",
      "PolicyName": "BackupPolicy2",
      "PolicyInheritedFrom": "Service",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "SuspensionInfo": {
        "IsSuspended": false,
        "SuspensionInheritedFrom": "Invalid"
      }
    }
  ]
}

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

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

Запрос

GET http://localhost:19080/Applications/CalcApp/$/GetBackupConfigurationInfo?api-version=6.4&ContinuationToken=fabric:/CalcApp/CalcService&MaxResults=2

Ответ 200

Текст
{
  "ContinuationToken": "",
  "Items": [
    {
      "Kind": "Partition",
      "PolicyName": "BackupPolicy2",
      "PolicyInheritedFrom": "Service",
      "ServiceName": "fabric:/CalcApp/CalcService",
      "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
      "SuspensionInfo": {
        "IsSuspended": true,
        "SuspensionInheritedFrom": "Partition"
      }
    }
  ]
}