GET все мониторы

Материал из Документация Ключ-АСТРОМ
Версия от 15:42, 21 октября 2022; ENetrebin (обсуждение | вклад) (Новая страница: «Список всех синтетических мониторов в вашей среде. Список содержит только имена и идент...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Список всех синтетических мониторов в вашей среде. Список содержит только имена и идентификаторы мониторов. Для получения сведений используйте вызов GET a monitor .

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

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

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

Параметры

Параметр Тип Описание In Необходимость
managementZone integer Отфильтровывает результирующий набор мониторов до тех, которые входят в указанную зону управления.

Здесь указывается идентификатор зоны управления.

query по желанию
tag string[] Фильтрует результирующий набор мониторов по указанным тегам.

Вы можете указать несколько тегов в следующем формате: tag=tag1&tag=tag2. Монитор должен соответствовать всем указанным тегам.

В случае тегов «ключ-значение», таких как импортированные теги AWS или CloudFoundry, используйте следующий формат: [context]key:value.

query по желанию
location string Отфильтровывает результирующий набор мониторов по тем, которые назначены указанному синтетическому местоположению.

Здесь указывается идентификатор локации.

query по желанию
assignedApps string[] Отфильтровывает результирующий набор мониторов до тех, которые назначены указанным приложениям.

Вы можете указать несколько приложений в следующем формате: assignedApps=app1&assignedApps=app2. На монитор должны быть назначены все указанные приложения.

Здесь указывается идентификаторы объектов Ключ-АСТРОМ для приложений.

query по желанию
type string Фильтрует результирующий набор мониторов до мониторов указанного типа: BROWSERили HTTP. query по желанию
enabled boolean Фильтрует результирующий набор мониторов на те, которые включены ( true) или отключены ( false). query по желанию
credentialId string Отфильтровывает результирующий набор мониторов, используя указанный набор учетных данных.

Здесь указывается идентификатор установленных здесь учетных данных.

query по желанию
credentialOwner string Отфильтровывает результирующий набор мониторов, используя учетные данные, принадлежащие указанному пользователю. query по желанию

Ответ

Коды ответов

Код Тип Описание
200 Monitors Успех

Объекты тела ответа

Объект Monitors

Список синтетических мониторов

Элемент Тип Описание
monitors MonitorCollectionElement[] Список синтетических мониторов.

Объект MonitorCollectionElement

Краткое изображение синтетического монитора.

Элемент Тип Описание
name string Имя синтетического объекта.
entityId string Идентификатор синтетического объекта.
type string Тип синтетического монитора.

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

  • BROWSER
  • HTTP
enabled boolean Состояние синтетического монитора.

JSON-модель тела ответа

{
  "monitors": [
    {
      "name": "string",
      "entityId": "string",
      "type": "BROWSER",
      "enabled": true
    }
  ]
}

Пример

В этом примере в запросе перечислены все доступные мониторы среды mySampleEnv .

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

Результат усекается до первых трех записей.

Curl

curl -X GET \
  https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/monitors \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

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

https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/monitors

Тело ответа

{
  "monitors": [
    {
      "name": "easyTravel Angular",
      "entityId": "SYNTHETIC_TEST-000000000000C69F"
    },
    {
      "name": "ruscomtech.ru",
      "entityId": "SYNTHETIC_TEST-0000000000025434"
    },
    {
      "name": "easytravel special offers",
      "entityId": "SYNTHETIC_TEST-000000000000987A"
    }
  ]
}

Код ответа

200