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

Получение списка сведений о приложении

  • Статья

Возвращает список приложений, созданных в кластере Service Fabric, которые соответствуют заданным фильтрам.

Возвращает сведения о приложении, которое создано или находится в процессе создания в кластере Service Fabric и которое соответствует указанным фильтрам. Ответ содержит имя, тип, состояние, параметры и другие сведения о приложении. Если сведения о приложении не помещаются на странице, возвращается одна страница результатов и маркер продолжения, который можно использовать для получения следующей страницы. Фильтры ApplicationTypeName и ApplicationDefinitionKindFilter не могут быть заданы одновременно.

Запрос

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

Параметры

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

api-version

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

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

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

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

ApplicationDefinitionKindFilter

Тип: целое число
Обязательный: нет
По умолчанию: 0

Используется для фильтрации по ApplicationDefinitionKind. Это механизм, необходимый для определения приложения Service Fabric.

  • Default — значение по умолчанию, которое выполняет ту же функцию, что и при выборе "Все". Значение равно 0.
  • Все — фильтр, соответствующий входным данным с любым значением ApplicationDefinitionKind. Значение равно 65 535.
  • ServiceFabricApplicationDescription — фильтр, который соответствует входным данным с значением ApplicationDefinitionKind ServiceFabricApplicationDescription. Значение равно 1.
  • Compose — фильтр, который соответствует входным данным со значением ApplicationDefinitionKind Compose. Значение равно 2.

ApplicationTypeName

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

Имя типа приложения, используемое для фильтрации запрашиваемых приложений. Это значение не должно содержать версию типа приложения.

ExcludeApplicationParameters

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

Флаг, указывающий, исключаются ли из результата параметры приложения.

ContinuationToken

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

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

MaxResults

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

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

timeout

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

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

Ответы

Код состояния HTTP Описание схеме ответа.
200 OK; Список приложений, созданных в кластере.
 PagedApplicationInfoList
Все остальные коды состояния Подробный ответ об ошибке.
 FabricError

Примеры

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

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

Запрос

GET http://localhost:19080/Applications?api-version=6.1&MaxResults=2

Ответ 200

Текст
{
  "ContinuationToken": "fabric:/samples/PQueueApp1",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    }
  ]
}

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

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

Запрос

GET http://localhost:19080/Applications?api-version=6.1&ContinuationToken=fabric:/samples/PQueueApp1&MaxResults=2

Ответ 200

Текст
{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    }
  ]
}