Вызов команды инфраструктуры

Статья
07/19/2023

Вызывает команду администрирования для заданного экземпляра службы инфраструктуры.

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

Доступные команды и соответствующий формат ответа различаются в зависимости от инфраструктуры, в которой выполняется кластер.

Этот API поддерживает платформу Service Fabric. Он не предназначен для использования непосредственно в коде.

Запрос

Метод	Универсальный код ресурса (URI) запроса
POST	`/$/InvokeInfrastructureCommand?api-version=6.0&Command={Command}&ServiceId={ServiceId}&timeout={timeout}`

Параметры

Имя	Тип	Обязательно	Расположение
`api-version`	строка	Да	Запрос
`Command`	строка	Да	Запрос
`ServiceId`	строка	Нет	Запрос
`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.

`Command`

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

Текст команды для вызова. Содержимое команды зависит от инфраструктуры.

`ServiceId`

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

Идентификатор службы инфраструктуры. Это полное имя службы инфраструктуры без схемы универсального кода ресурса (URI) "fabric:". Этот параметр обязателен только для кластеров, в которых выполняется более одного экземпляра службы инфраструктуры.

`timeout`

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

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

Ответы

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

Share via