POST изменение состояния прочих мониторов

Материал из Документация Ключ-АСТРОМ

Изменяет рабочее состояние всех сторонних мониторов.

Запрос использует в качестве полезной нагрузки application/json формат.

POST Managed https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/ext/stateModifications
Среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/ext/stateModifications

Аутентификация

Чтобы выполнить этот запрос, вам нужен токен доступа с областью создания и чтения синтетических мониторов, местоположений и узлов ( ExternalSyntheticIntegration) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр Тип Описание In Необходимость
body StateModification Тело JSON запроса. Содержит новый рабочий статус сторонних синтетических мониторов. body требуется

Объекты тела запроса

Объект StateModification

Рабочее состояние будет установлено для всех синтетических мониторов сторонних производителей.

Элемент Тип Описание Необходимость
state string Новое рабочее состояние для всех сторонних синтетических мониторов.

Элемент может содержать эти значения

  • ACTIVE
  • HIDDEN
  • INACTIVE
требуется

JSON-модель тела запроса

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.

{
  "state": "ACTIVE"
}

Ответ

Коды ответов

Код Тип Описание
204 Успех. Изменено состояние сторонних мониторов.
400 ErrorEnvelope Не удалось. Ввод недействителен.

Пример

В этом примере запрос устанавливает состояние сторонних мониторов как активное .

Маркер API передается в заголовке авторизации .

Завиток

curl -X POST \
  https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/ext/stateModifications \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \
  -d '{
  "state": "ACTIVE"
}
'

URL-адрес запроса

https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/ext/stateModifications

Тело запроса

{
  "state": "ACTIVE"
}

Код ответа

204