Получение сведений о развернутом приложении
Возвращает сведения о приложении, развернутом на узле Service Fabric.
Если предоставленный идентификатор приложения предназначен для системного приложения, то этот запрос возвращает сведения о системном приложении. Результаты охватывают развернутые приложения в активном состоянии, состоянии активации и загрузки. Для этого запроса необходимо, чтобы имя узла соответствовало имени узла в кластере. Если имя указанного узла не указывает на любой из активных узлов Service Fabric в кластере, запрос завершается ошибкой.
Запрос
| Метод | Универсальный код ресурса (URI) запроса |
|---|---|
| GET | /Nodes/{nodeName}/$/GetApplications/{applicationId}?api-version=6.1&timeout={timeout}&IncludeHealthState={IncludeHealthState} |
Параметры
| Имя | Тип | Обязательно | Расположение |
|---|---|---|---|
nodeName |
строка | Да | Путь |
applicationId |
строка | Да | Путь |
api-version |
строка | Да | Запрос |
timeout |
integer (int64) | Нет | Запрос |
IncludeHealthState |
Логическое | Нет | Запрос |
nodeName
Тип: string
Обязательный: да
Имя узла.
applicationId
Тип: string
Обязательный: да
Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:".
Начиная с версии 6.0, иерархические имена разделяются знаком "~".
Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1".
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.
timeout
Тип: integer (int64)
Обязательный: нет
По умолчанию: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд.
IncludeHealthState
Тип: boolean
Обязательный: нет
По умолчанию: false
Добавление состояния работоспособности сущности.
Если этот параметр имеет значение false или не указан, возвращается состояние работоспособности Unknown.
Если для этого параметра задано значение true, параллельно выполняется запрос к узлу и службе системы работоспособности, после чего результаты объединяются.
В результате запрос требует больше ресурсов и времени.
Ответы
| Код состояния HTTP | Описание | схеме ответа. |
|---|---|---|
| 200 OK; | Успешная операция вернет код состояния 200 и сведения о развернутом приложении. |
DeployedApplicationInfo |
| 204 (NoContent) | Если указанное приложение не развернуто на узле, возвращается пустой ответ. |
|
| Все остальные коды состояния | Подробный ответ об ошибке. |
FabricError |
Примеры
Получение определенного развернутого приложения по идентификатору приложения и включение состояния работоспособности в результат
В этом примере показано, как получить сведения о приложении, развернутом на указанном узле, с помощью идентификатора приложения. Если приложение найдено, возвращается информация с кодом состояния 200. Если указанное приложение не развернуто на узле, возвращается пустой ответ с кодом состояния 204.
Запрос
GET http://localhost:19080/Nodes/_Node_0/$/GetApplications/samples~CalculatorApp?api-version=6.1&IncludeHealthState=True
Ответ 200
Текст
{
"Id": "samples~CalculatorApp",
"Name": "fabric:/samples/CalculatorApp",
"TypeName": "CalculatorApp",
"TypeVersion": "1.0.0",
"Status": "Active",
"WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\work",
"LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\log",
"TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\temp",
"HealthState": "Ok"
}
Ответ 204
Текст
Текст ответа пуст.