Получение списка сведений о типе приложения по имени
Возвращает список типов приложений в кластере Service Fabric, которые соответствуют точно указанному имени.
Возвращает сведения о типах приложений, которые подготовлены или подготавливаются в кластере Service Fabric. Эти результаты содержат типы приложений, имена которых совпадают со значением, указанным в качестве параметра, и которые соответствуют заданным параметрам запроса. Возвращаются все версии типа приложения, соответствующего заданному имени типа приложения, при этом каждая версия возвращаются как тип приложения. Ответ содержит имя, версию, состояние и другие сведения о типе приложения. Это страничный запрос. Это значит, что если сведения о типах приложений не помещаются на странице, возвращается одна страница результатов и маркер продолжения, который можно использовать для получения следующей страницы. Например, если существуют 10 типов приложения, но страница вмещает только первые 3 типа, или задано максимальное число результатов, равное 3, тогда возвращаются 3 типа. Чтобы просмотреть остальную часть результатов, можно получить следующие страницы с помощью маркера продолжения, передав его в следующем запросе. Если следующие страницы отсутствуют, возвращается пустой маркер продолжения.
Запрос
| Метод | Универсальный код ресурса (URI) запроса |
|---|---|
| GET | /ApplicationTypes/{applicationTypeName}?api-version=6.0&ApplicationTypeVersion={ApplicationTypeVersion}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout} |
Параметры
| Имя | Тип | Обязательно | Расположение |
|---|---|---|---|
applicationTypeName |
строка | Да | Путь |
api-version |
строка | Да | Запрос |
ApplicationTypeVersion |
строка | Нет | Запрос |
ExcludeApplicationParameters |
Логическое | Нет | Запрос |
ContinuationToken |
строка | Нет | Запрос |
MaxResults |
целое число (int64) | Нет | Запрос |
timeout |
целое число (int64) | Нет | Запрос |
applicationTypeName
Тип: строка
Обязательный: да
Имя типа приложения.
api-version
Тип: строка
Обязательный: да
По умолчанию: 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.
ApplicationTypeVersion
Тип: строка
Обязательный: нет
Версия типа приложения.
ExcludeApplicationParameters
Тип: boolean
Обязательный: нет
По умолчанию: false
Флаг, указывающий, исключаются ли из результата параметры приложения.
ContinuationToken
Тип: строка
Обязательный: нет
Параметр маркера продолжения используется для получения следующего набора результатов. Маркер продолжения с непустым значением добавляется в ответ API, когда результаты из системы не помещаются в один ответ. Когда это значение передается в следующем вызове API, API возвращает следующий набор результатов. Если результаты отсутствуют, маркер продолжения не будет содержать значение. Значение этого параметра не должно быть указано в формате URL-адреса.
MaxResults
Тип: integer (int64)
Обязательный: нет
По умолчанию: 0
InclusiveMinimum: 0
Максимальное количество результатов, возвращаемых в результате страничного запроса. Этот параметр определяет максимальное число возвращаемых результатов. Возвращаемых результатов может быть меньше, чем указанное максимальное количество результатов, если они не помещаются в сообщении согласно ограничениям максимального размера сообщения, определенным в конфигурации. Если этот параметр равен нулю или не указан, то результат страничного запроса содержит максимальное число результатов, помещающееся в возвращаемом сообщении.
timeout
Тип: integer (int64)
Обязательный: нет
По умолчанию: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд.
Ответы
| Код состояния HTTP | Описание | схеме ответа. |
|---|---|---|
| 200 OK; | Список типов приложений в кластере. |
PagedApplicationTypeInfoList |
| Все остальные коды состояния | Подробный ответ об ошибке. |
FabricError |