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

Статья
07/19/2023

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

Возвращает сведения о типах приложений, которые подготовлены или подготавливаются в кластере Service Fabric. Каждая версия типа приложения возвращается как один тип приложения. Ответ содержит имя, версию, состояние и другие сведения о типе приложения. Это страничный запрос. Это значит, что если сведения о типах приложений не помещаются на странице, возвращается одна страница результатов и маркер продолжения, который можно использовать для получения следующей страницы. Например, если существуют 10 типов приложения, но страница вмещает только первые 3 типа, или задано максимальное число результатов, равное 3, тогда возвращаются 3 типа. Чтобы просмотреть остальную часть результатов, можно получить следующие страницы с помощью маркера продолжения, передав его в следующем запросе. Если следующие страницы отсутствуют, возвращается пустой маркер продолжения.

Запрос

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

Параметры

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

`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.

`ApplicationTypeDefinitionKindFilter`

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

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

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

`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;	Список типов приложений в кластере.	PagedApplicationTypeInfoList
Все остальные коды состояния	Подробный ответ об ошибке.	FabricError

Примеры

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

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

Запрос

GET http://localhost:19080/ApplicationTypes?api-version=6.0&MaxResults=5

Ответ 200

Текст

{
  "ContinuationToken": "PersistentQueueApp+2.0",
  "Items": [
    {
      "Name": "CalculatorApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "ServiceInstanceCount",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "CalculatorApp",
      "Version": "2.0",
      "DefaultParameterList": [
        {
          "Key": "ServiceInstanceCount",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "GatewayApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "GatewayPort",
          "Value": "8505"
        },
        {
          "Key": "ServiceInstanceCount",
          "Value": "1000"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    }
  ]
}

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

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

Запрос

GET http://localhost:19080/ApplicationTypes?api-version=6.0&ContinuationToken=PersistentQueueApp+2.0&MaxResults=5

Ответ 200

Текст

{
  "ContinuationToken": "",
  "Items": [
    {
      "Name": "VolatileQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "VolatileQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    }
  ]
}

Исключение параметров приложения из результата

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

Запрос

GET http://localhost:19080/ApplicationTypes?api-version=6.0&ExcludeApplicationParameters=True

Ответ 200

Текст

{
  "ContinuationToken": "",
  "Items": [
    {
      "Name": "CalculatorApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "CalculatorApp",
      "Version": "2.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "GatewayApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "VolatileQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "VolatileQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [],
      "Status": "Available"
    }
  ]
}

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

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

Запрос

Параметры

`api-version`

`ApplicationTypeDefinitionKindFilter`

`ExcludeApplicationParameters`

`ContinuationToken`

`MaxResults`

`timeout`

Ответы

Примеры

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

Запрос

Ответ 200

Текст

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

Запрос

Ответ 200

Текст

Исключение параметров приложения из результата

Запрос

Ответ 200

Текст

Дополнительные ресурсы