API Ключ-АСТРОМ: различия между версиями

Материал из Документация Ключ-АСТРОМ
 
(не показано 226 промежуточных версий 3 участников)
Строка 1: Строка 1:
Используйте Ключ-АСТРОМ API для автоматизации задач мониторинга и экспорта различных типов данных в сторонние инструменты отчетности и анализа. Обмен данными через API обеспечивает безопасность за счет использования защищенного обмена данными по протоколу HTTPS.
== Основное ==
* [[Токены и аутентификация (API)]]
* [[Коды ответа (API)]]
* [[Ограничение доступа (API)]]
* [[Предпросмотр и бета версии (API)]]
 
== Эндпойнты среды ==
 
=== АктивныеШлюзы ===
* Информация
**[[GET информацию о всех АктивныхШлюзах]]
**[[GET информацию о конкретном АктивномШлюзе]]
* Конфигурация автообновления
**[[GET глобальную конфигурацию]]
**[[Редактировать глобальную конфигурацию]]
**[[GET АктивныйШлюз]]
**[[Редактировать АктивныйШлюз]]
* Задания автообновлений
**[[GET все задания автообновления]]
**[[GET конкретное задание автообновления]]
**[[POST задание автообновления]]
**[[DELETE задание автообновления]]
**[[GET АктивныхШлюзов с автообновлением заданий]]
 
=== Анонимизация ===
 
*[[PUT задания анонимизации]]
*[[GET статус анонимизации]]
 
=== Безопасность приложения ===
 
* Проблемы безопасности
** Получить список проблем безопасности в среде
** Получить информацию о конкретной проблеме безопасности
** Скрыть проблему
** Показать проблему
** Получить список исправлений
** Скрыть/показать исправление
** Получить список уязвимых функций
* [[Советник по безопасности ИИ]]
 
=== Логи аудита ===
 
* [[GET лога аудита]]
*[[GET запись лога аудита]]
 
=== Информация о кластере ===
[[GET информацию о кластере]]


== Основное ==
=== Пользовательские теги ===
[[Аутентификация (API)]]
 
[[Коды ответа (API)]]
*[[GET теги]]
[[Ограничение доступа (API)]]
* [[POST-теги]]
[[Предпросмотр и бета версии (API)]]
*[[DELETE тегов]]
 
=== Развёртывание ===
 
* ЕдиныйАгент
** Скачать последнюю версию
** Скачать конкретную версию
**
* АктивныйШлюз
* BOSH-Тарболлы
* [[Тарболлы оркестровки]]
 
*
*События v1
**[[GET ленты событий]]
**[[GET события]]
**[[POST события]]
**[[Отправка событий развертывания из Jenkins]]
*События v2
**[[GET списка событий]]
**[[GET события v2]]
**[[POST события v2]]
**[[GET всех типов событий]]
**[[GET типа события]]
**[[GET всех свойств события]]
**[[GET свойства события]]
*Расширения 2.0
**Конфигурации среды
***[[Расширения 2.0 API - GET активация|GET конфигурации среды]]
***[[PUT конфигурации среды]]
***[[POST активации конфигурации]]
***[[DELETE деактивация конфигурации]]
***[[GET списка событий - Расширения 2.0|GET списка событий]]
**Расширения
***[[GET всех расширений - Расширения|GET всех расширений]]
***[[GET версии расширения]]
***[[GET расширения]]
***[[POST файла расширения]]
***[[DELETE версии расширения]]
***[[GET схемы расширения]]
**Конфигурации мониторинга
***[[GET всех конфигураций мониторинга]]
***[[GET конфигурации мониторинга]]
***[[POST конфигурации мониторинга]]
***[[PUT конфигурации мониторинга]]
***[[DELETE конфигурации мониторинга]]
***[[GET списка событий - Конфигурации мониторинга|GET списка событий]]
***[[GET статуса]]
**Схемы
***[[GET всех схем]]
***[[GET всех файлов]]
***[[GET файла]]
*Мониторинг логов
**[[GET лога поиска]]
**[[GET лога экспорта]]
**[[GET сводного лога]]
**[[POST лога нагрузки]]
*Таймсерии v1
**[[Пользовательские метрики]]
***[[PUT пользовательской метрики]]
***[[DELETE пользовательской метрики - Пользовательские метрики|DELETE пользовательской метрики]]
**Определение метрик
***[[GET списка метрик]]
***[[GET определения метрик]]
**Чтение точек данных
***[[GET точек данных]]
***[[POST точек данных]]
 
*Метрики v2
**[[GET метрик]]
**[[Получение дескриптора метрики]]
**[[Получение точки данных метрики]]
**[[Селектор показателей]]
**[[Выражение метрик]]
**[[POST введённых точек данных]]
**[[DELETE пользовательской метрики]]
**Примеры и варианты использования
***[[Список всех метрик]]
***[[Выбор нескольких метрик]]
***[[Выбор полного поддерева метрик]]
**[[FAQ]]
*Единицы метрик
**[[GET всех единиц метрик]]
**[[GET одной единицы метрик]]
**[[API метрик - GET - конвертировать единицы|GET - конвертировать единицы]]


*Сетевые зоны
**[[GET всех сетевых зон]]
**[[GET одной сетевой зоны]]
**[[PUT сетевой зоны]]
**[[DELETE сетевой зоны]]
**[[GET глобальной конфигурации]]
**[[PUT глобальной конфигурации]]
*[[ЕдиныйАгент на хосте]]
*[[Топология и Smartscape v1]]
**[[Приложения]]
***[[GET все приложения]]
***[[GET приложение]]
***[[POST тегов]]
***[[GET базового уровня]]
**[[Хосты]]
***[[GET все хосты]]
***[[GET хост]]
***[[POST тэгов]]
***[[DELETE тэга]]
**Процессы
***[[GET все процессы]]
***[[GET процесс]]
**Группы процессов
***[[GET все группы процессов]]
***[[GET группы процессов]]
***[[POST тэгов*|POST тэгов]]
**Сервисы
***[[GET все сервисы]]
***[[GET сервис]]
***[[POST тэгов**|POST тэгов]]
***[[GET базового уровня*|GET базового уровня]]
**[[Пользовательские устройства]]
***[[Создание пользовательского устройства]]
***[[Отчёт о метрике пользовательского устройства]]
*Отслеживаемые объекты v2
**[[GET список объектов]]
**[[GET объект]]
**[[GET все типы объектов]]
**[[GET тип объектов]]
**[[POST пользовательское устройство]]
**[[Селектор объектов]]


== Эндпоинты ==
*Проблемы v2
=== Эндпоинтысреды ===
**[[JSON-модели]]
**Комментарии
***[[GET все комментарии]]
***[[GET комментарий]]
***[[POST комментарий]]
***[[PUT комментарий]]
***[[DELETE комментарий]]
**Проблемы
***[[GET список*|GET список]]
***[[GET детали]]
***[[POST закрытие проблемы]]


=== Эндпоинты конфигурации ===
*Релизы
**[[GET релизы]]
*Удалённое управление конфигурацией
**ЕдиныйАгент
***[[POST задание конфигурации]]
***[[POST предпросмотр работы]]
***[[GET текущая работа]]
***[[GET готовые работы]]
***[[GET задание по настройке]]
**АктивныйШлюз
*** [[POST задание конфигурации*|POST задание конфигурации]]
*** [[POST предпросмотр работы*|POST предпросмотр работы]]
*** [[GET текущая работа*|GET текущая работа]]
*** [[GET готовые работы*|GET готовые работы]]
*** [[GET задание по настройке*|GET задание по настройке]]
* [[Браузерное расширение Real User Monitoring]]
* Мониторинг реального пользователя (RUM)
**Географические регионы
***[[GET страны]]
***[[GET регионы]]
***[[GET регионы страны]]
***[[GET города страны]]
***[[GET города региона]]
**RUM JavaScript
***[[GET список инжектированных приложений]]
***[[GET последняя версия]]
***[[GET текущая версия]]
***[[GET тег JavaScript]]
***[[GET тег JavaScript ЕдиныйАгент]]
***[[GET фрагмент кода синхронизации]]
***[[GET фрагмент асинхронного кода]]
***[[GET встроенный код]]
**Сеансы пользователей
***[[GET таблица]]
***[[GET дерево]]
***[[Структура сеанса пользователя]]
* Цели уровня обслуживания (SLO)
**[[GET все SLO]]
**[[GET один SLO]]
**[[POST один SLO]]
**[[PUT один SLO]]
**[[DELETE один SLO]]
* Настройки
**Объекты
***[[GET объекты]]
***[[GET объект*|GET объект]]
***[[POST объект]]
***[[PUT объект]]
***[[DELETE объект]]
***[[GET эффективные значения]]
**Схемы
***[[GET все схемы]]
***[[GET схема]]
*Синтетика v1
**Синтетические мониторы
***[[GET все мониторы]]
***[[GET монитор]]
***[[POST монитор]]
***[[PUT монитор]]
***[[DELETE монитор]]
***[[JSON модели*|JSON модели]]
**Синтетические локации
***[[GET все локации*|GET все локации]]
***[[GET локация*|GET локация]]
***[[POST локация*|POST локация]]
***[[PUT локация*|PUT локация]]
***[[DELETE локация*|DELETE локация]]
***[[GET статус локации*|GET статус локации]]
***[[PUT статус локации*|PUT статус локации]]
***[[JSON модели**|JSON модели]]
**Синтетические ноды
***[[GET все ноды*|GET все ноды]]
***[[GET нода*|GET нода]]
**Прочая синтетика
***[[POST прочие мониторы]]
***[[POST прочие события]]
***[[POST изменение состояния прочих мониторов]]
* Синтетика v2
**Синтетические локации
***[[GET все локации]]
***[[GET локация]]
***[[POST локация]]
***[[PUT локация]]
***[[DELETE локация]]
***[[GET статус локации]]
***[[PUT статус локации]]
***[[JSON модели]]
**Синтетические ноды
***[[GET все ноды]]
***[[GET нода]]
**Отслеживание выполнения
***[[GET HTTP монитор]]
***[[GET все выполнения по требованию]]
***[[GET основная информация о выполнении]]
***[[GET полная информация о выполнении]]
***[[POST пакетное выполнение]]
***[[GET сводка о пакетном выполнении]]
**Конфигурация
***[[GET конфигурация]]
***[[PUT конфигурация]]
* Токены v2
**Токены доступа
***[[GET все токены]]
***[[GET токен]]
***[[POST поиск токена]]
***[[POST токен]]
***[[PUT токен]]
***[[DELETE токен]]
**Токены АктивногоШлюза
***[[GET все токены*|GET все токены]]
***[[GET токен*|GET токен]]
***[[POST токен*|POST токен]]
***[[DELETE токен*|DELETE токен]]
**Токены владельца
***[[POST старт ротации]]
***[[POST окончания ротации]]
***[[POST отмены ротации]]


== Эндпойнты конфигурации ==
*
* Обнаружение аномалий
**[[Обнаружение аномалий API - Приложения|Приложение]]
***[[Обнаружение аномалий приложения API - GET конфигурация|GET конфигурация]]
***[[Обнаружение аномалий приложения API - PUT конфигурация|PUT конфигурация]]
**[[Обнаружение аномалий API - AWS|AWS]]
***[[AWS обнаружение аномалий API - GET конфигурация|GET конфигурация]]
***[[AWS обнаружение аномалий API - PUT конфигурация|PUT конфигурация]]
**[[Обнаружение аномалий API - Службы базы данных|Службы базы данных]]
***[[Обнаружение аномалий базы данных API - GET конфигурация|GET конфигурация]]
***[[Обнаружение аномалий базы данных API - PUT конфигурация|PUT конфигурация]]
**[[Обнаружение аномалий API - Дисковые события|Дисковые события]]
***[[Обнаружение аномалий дисковых событий API - GET все события|GET все события]]
***[[Обнаружение аномалий дисковых событий API - GET событие|GET событие]]
***[[Обнаружение аномалий дисковых событий API - POST событие|POST событие]]
***[[Обнаружение аномалий дисковых событий API - PUT событие|PUT событие]]
***[[Обнаружение аномалий дисковых событий API - DELETE событие|DELETE событие]]
**[[Обнаружение аномалий API - Хосты|Хосты]]
***[[Обнаружение аномалий хоста API - GET конфигурация|GET конфигурация]]
***[[Обнаружение аномалий хоста API - PUT конфигурация|PUT конфигурация]]
**[[Обнаружение аномалий API - События метрик|События метрик]]
***[[Обнаружение аномалий событий метрик API - GET все события|GET все события]]
***[[Обнаружение аномалий событий метрик API - GET событие|GET событие]]
***[[Обнаружение аномалий событий метрик API - POST событие|POST событие]]
***[[Обнаружение аномалий событий метрик API - PUT событие|PUT событие]]
***[[Обнаружение аномалий событий метрик API - DELETE событие|DELETE событие]]
***[[Обнаружение аномалий событий метрик API - JSON модель|JSON модель]]
**[[API обнаружения аномалий - Группы процессов|Группы процессов]]
***[[API обнаружения аномалий групп процессов - GET конфигурация|GET конфигурация]]
***[[API обнаружения аномалий групп процессов - PUT конфигурация|PUT конфигурация]]
***[[API обнаружения аномалий групп процессов - DELETE конфигурация|DELETE конфигурация]]
**[[API обнаружения аномалий - Службы|Службы]]
***[[API обнаружения аномалий служб - GET конфигурация|GET конфигурация]]
***[[API обнаружения аномалий служб - PUT конфигурация|PUT конфигурация]]
**[[API обнаружения аномалий - VMware|VMware]]
***[[API обнаружения аномалий VMware - GET конфигурация|GET конфигурация]]
***[[API обнаружения аномалий VMware - PUT конфигурация|PUT конфигурация]]
* [[API автоматически применяемых тегов|Автоматические теги]]
**[[API автоматически применяемых тегов - GET все автоматические теги|GET все автоматические теги]]
**[[API автоматически применяемых тегов - GET автоматический тег|GET автоматический тег]]
**[[API автоматически определяемых тегов - POST автоматический тег|POST автоматический тег]]
**[[API автоматически применяемых тегов - PUT автоматический тег|PUT автоматический тег]]
**[[API автоматически применяемых тегов - DELETE автоматический тег|DELETE автоматический тег]]
**[[API автоматически применяемых тегов - JSON модели|JSON модели]]
* Учётные данные AWS
**[[API учётных данных AWS - GET все учётные данные|GET все учётные данные]]
**[[API учётных данных AWS - POST новые учётные данные|POST новые учётные данные]]
**[[API учётных данных AWS - GET учётные данные|GET учётные данные]]
**[[API учётных данных AWS - PUT учётные данные|PUT учётные данные]]
**[[API учётных данных AWS - DELETE учётные данные|DELETE учётные данные]]
**[[API учётных данных AWS - GET службы мониторинга|GET службы мониторинга]]
**[[API учётных данных AWS - PUT службы мониторинга|PUT службы мониторинга]]
* [[AWS PrivateLink]]
* [[Учётные данные Azure]]
* [[Расчётные метрики]]
* [[Учётные данные Cloud Foundry]]
* [[Условное наименование]]
* [[Хранилище учётных данных]]
* [[Дашборды]]
**[[Получить информацию о всех дашбордах]]
**[[Получить информацию о конкретном дашборде]]
* [[Конфиденциальность данных]]
* [[Расширения (Эндпойнты конфигурации)|Расширения]]
* [[Частота обнаружения проблем]]
* [[Учётные данные Kubernetes]]
* [[Окна обслуживания]]
* [[Зоны управления]]
* [[Мобильная символика]]
* [[Уведомления]]
* [[Конфигурация ЕдиногоАгента]]
* [[Плагины]]
* [[API Удалённых сред]]
* [[Отчёты]]
* [[RUM]]
* [[Сервисы]]


Используйте Ключ-АСТРОМ API для автоматизации задач мониторинга и экспорта различных типов данных в сторонние инструменты отчетности и анализа. Обмен данными через API обеспечивает безопасность за счет использования защищенного обмена данными по протоколу HTTPS.<br>
== API Explorer ==
== API Explorer ==
Вы можете получить доступ ко всем конечным точкам API Ключ-АСТРОМ с помощью API Explorer.
Вы можете получить доступ ко всем конечным точкам API Ключ-АСТРОМ с помощью API Explorer.
Строка 23: Строка 398:
В качестве альтернативы вы можете получить доступ к API Explorer по прямой ссылке:
В качестве альтернативы вы можете получить доступ к API Explorer по прямой ссылке:
https://{ваш-домен}/e/{id-среды}/rest-api-doc/
https://{ваш-домен}/e/{id-среды}/rest-api-doc/
Аутентификация в API Explorer<br>
Выберите значок замка рядом с любым эндпоинтом, чтобы отобразить информацию о токенах API, которые защищают этот эндпоинт. Каждый эндпоинт требует определенного типа токена.
Вы также можете разблокировать все эндпоинты, выбрав '''Авторизовать''' . В отображаемом диалоговом окне вы можете увидеть, какие разрешения токена необходимы для каждого эндпоинта API. Введя свой API токен в диалоговое окно '''Доступные авторизации''' , вы можете разблокировать все связанные эндпоинты API.
Попробуйте сделать вызов API<br>
После того, как вы ввели свой токен API, вы можете напрямую выполнять вызовы API в проводнике API. Клик по кнопке «'''Попробовать'''» открывает раздел параметров выбранного эндпоинта API, где вы можете ввести дополнительные параметры и изменить полезную нагрузку запроса перед его выполнением, нажав кнопку «'''Выполнить'''» .

Текущая версия на 02:52, 4 июля 2024

Основное

Эндпойнты среды

АктивныеШлюзы

Анонимизация

Безопасность приложения

  • Проблемы безопасности
    • Получить список проблем безопасности в среде
    • Получить информацию о конкретной проблеме безопасности
    • Скрыть проблему
    • Показать проблему
    • Получить список исправлений
    • Скрыть/показать исправление
    • Получить список уязвимых функций
  • Советник по безопасности ИИ

Логи аудита

Информация о кластере

GET информацию о кластере

Пользовательские теги

Развёртывание

  • ЕдиныйАгент
    • Скачать последнюю версию
    • Скачать конкретную версию
  • АктивныйШлюз
  • BOSH-Тарболлы
  • Тарболлы оркестровки

Эндпойнты конфигурации

Используйте Ключ-АСТРОМ API для автоматизации задач мониторинга и экспорта различных типов данных в сторонние инструменты отчетности и анализа. Обмен данными через API обеспечивает безопасность за счет использования защищенного обмена данными по протоколу HTTPS.

API Explorer

Вы можете получить доступ ко всем конечным точкам API Ключ-АСТРОМ с помощью API Explorer.

  1. Выберите Настройки в меню навигации.
  2. Перейдите в Интеграция> Ключ-АСТРОМ API .
  3. Кликните ссылку Ключ-АСТРОМ API Explorer вверху страницы.

В качестве альтернативы вы можете получить доступ к API Explorer по прямой ссылке: https://{ваш-домен}/e/{id-среды}/rest-api-doc/


Аутентификация в API Explorer

Выберите значок замка рядом с любым эндпоинтом, чтобы отобразить информацию о токенах API, которые защищают этот эндпоинт. Каждый эндпоинт требует определенного типа токена.

Вы также можете разблокировать все эндпоинты, выбрав Авторизовать . В отображаемом диалоговом окне вы можете увидеть, какие разрешения токена необходимы для каждого эндпоинта API. Введя свой API токен в диалоговое окно Доступные авторизации , вы можете разблокировать все связанные эндпоинты API.


Попробуйте сделать вызов API

После того, как вы ввели свой токен API, вы можете напрямую выполнять вызовы API в проводнике API. Клик по кнопке «Попробовать» открывает раздел параметров выбранного эндпоинта API, где вы можете ввести дополнительные параметры и изменить полезную нагрузку запроса перед его выполнением, нажав кнопку «Выполнить» .

Источник — https://doc.ruscomtech.ru/index.php?title=API_Ключ-АСТРОМ&oldid=3987