Обнаружение аномалий дисковых событий API - GET все события

Материал из Документация Ключ-АСТРОМ
Версия от 15:53, 27 октября 2022; ENetrebin (обсуждение | вклад) (→‎Пример)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Список всех существующих правил событий диска.

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

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

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

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

Параметры

Запрос не предоставляет никаких настраиваемых параметров.

Ответ

Коды ответов

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

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

Объект StubList

Упорядоченный список кратких представлений сущностей Ключ-АСТРОМ.

Элемент Тип Описание
values EntityShortRepresentation[] Упорядоченный список кратких представлений объектов Ключ-АСТРОМ.

Объект EntityShortRepresentation

Краткое представление объекта .

Элемент Тип Описание
id string Идентификатор объекта Ключ-АСТРОМ.
name string Имя объекта Ключ-АСТРОМ.
description string Краткое описание сущности Ключ-АСТРОМ.

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

{
  "values": [
    {
      "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
      "name": "Astromkey entity 1",
      "description": "Astromkey entity 1 for the REST API example"
    },
    {
      "id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
      "name": "Astromkey entity 2"
    },
    {
      "id": "8cdabe77-9e1a-4be8-b3df-269dd6fa9d7f"
    }
  ]
}

Пример

В этом примере в запросе перечислены все настраиваемые правила обработки событий на диске в среде.

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

В запросе перечислены следующие настраиваемые правила событий диска:

Disk1.png

Curl

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

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

https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/diskEvents

Тело ответа

{
  "values": [
    {
      "id": "3f7b8234-95dc-44d0-9c1b-a5f0e8e19fd0",
      "name": "low disk"
    }
  ]
}

Код ответа

200