Получение описания службы

  • Статья

Возвращает описание существующей службы Service Fabric.

Возвращает описание существующей службы Service Fabric. Служба должна быть создана, прежде чем можно будет извлечь ее описание.

Запрос

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

Параметры

Имя Тип Обязательно Расположение
serviceId строка Да Путь
api-version строка Да Запрос
timeout integer (int64) Нет Запрос

serviceId

Тип: string
Обязательный: да

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

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.

timeout

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

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

Ответы

Код состояния HTTP Описание схеме ответа.
200 OK; После успешной операции возвращается код состояния 200.
 ServiceDescription
Все остальные коды состояния Подробный ответ об ошибке.
 FabricError