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

Статья
08/05/2023

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

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

Запрос

Метод	Универсальный код ресурса (URI) запроса
GET	`/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes/{serviceTypeName}?api-version=6.0&ServiceManifestName={ServiceManifestName}&timeout={timeout}`

Параметры

Имя	Тип	Обязательно	Расположение
`nodeName`	строка	Да	Путь
`applicationId`	строка	Да	Путь
`serviceTypeName`	строка	Да	Путь
`api-version`	строка	Да	Запрос
`ServiceManifestName`	строка	Нет	Запрос
`timeout`	целое число (int64)	Нет	Запрос

`nodeName`

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

Имя узла.

`applicationId`

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

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

`serviceTypeName`

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

Задает имя для типа службы Service Fabric.

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

`ServiceManifestName`

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

Имя манифеста службы, по которому фильтруется список типов развернутых служб. Если указан этот параметр, ответ будет содержать сведения только о службах тех типов, которые определены в указанном манифесте службы.

`timeout`

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

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

Ответы

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

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