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

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

  • Статья

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

Возвращает сведения о приложении, которое создано или находится в процессе создания в кластере Service Fabric и имя которого совпадает со значением, указанным в качестве параметра. Ответ содержит имя, тип, состояние, параметры и другие сведения о приложении.

Запрос

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

Параметры

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

applicationId

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

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

api-version

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

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

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

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

ExcludeApplicationParameters

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

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

timeout

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

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

Ответы

Код состояния HTTP Описание схеме ответа.
200 OK; Сведения о приложении.
 ApplicationInfo
204 (NoContent) Если указанный идентификатор applicationId не найден в кластере, возвращается пустой ответ.
Все остальные коды состояния Подробный ответ об ошибке.
 FabricError

Примеры

Получение определенного приложения по идентификатору приложения

В этом примере показано, как получить сведения о приложении с помощью его идентификатора. Если приложение найдено, сведения о нем возвращаются с кодом состояния 200. Если приложение не найдено, возвращается пустое содержимое с кодом состояния 204.

Запрос

GET http://localhost:19080/Applications/samples~CalculatorApp?api-version=6.0

Ответ 200

Текст
{
  "Id": "samples~CalculatorApp",
  "Name": "fabric:/samples/CalculatorApp",
  "TypeName": "CalculatorApp",
  "TypeVersion": "1.0",
  "Status": "Ready",
  "Parameters": [
    {
      "Key": "CalculatorAppParameter1",
      "Value": "314"
    },
    {
      "Key": "CalculatorAppParameter2",
      "Value": "271"
    }
  ],
  "HealthState": "Ok",
  "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
}

Ответ 204

Текст

Текст ответа пуст.