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

  • Статья

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

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

Запрос

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

Параметры

Имя Тип Обязательно Расположение
applicationTypeName строка Да Путь
api-version строка Да Запрос
ApplicationTypeVersion строка Да Запрос
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

Тип: строка
Обязательный: да

Версия типа приложения.

timeout

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

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

Ответы

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

Примеры

Получение сведений обо всех узлах.

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

Запрос

GET http://localhost:19080/ApplicationTypes/Application2Type/$/GetServiceTypes?api-version=6.0&ApplicationTypeVersion=1.0.0

Ответ 200

Текст
[
  {
    "ServiceTypeDescription": {
      "IsStateful": true,
      "ServiceTypeName": "Actor1ActorServiceType",
      "PlacementConstraints": "",
      "HasPersistedState": true,
      "Kind": "Stateful",
      "Extensions": [
        {
          "Key": "__GeneratedServiceType__",
          "Value": "<GeneratedNames xmlns=\"http://schemas.microsoft.com/2015/03/fabact-no-schema\">\r\n            <DefaultService Name=\"Actor1ActorService\" />\r\n            <ReplicatorEndpoint Name=\"Actor1ActorServiceReplicatorEndpoint\" />\r\n            <ReplicatorConfigSection Name=\"Actor1ActorServiceReplicatorConfig\" />\r\n            <ReplicatorSecurityConfigSection Name=\"Actor1ActorServiceReplicatorSecurityConfig\" />\r\n            <StoreConfigSection Name=\"Actor1ActorServiceLocalStoreConfig\" />\r\n            <ServiceEndpointV2 Name=\"Actor1ActorServiceEndpointV2\" />\r\n          </GeneratedNames>"
        }
      ],
      "LoadMetrics": [],
      "ServicePlacementPolicies": []
    },
    "ServiceManifestVersion": "1.0.0",
    "ServiceManifestName": "Actor1Pkg",
    "IsServiceGroup": false
  }
]