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

Материал из Документация Ключ-АСТРОМ
 
(не показано 85 промежуточных версий этого же участника)
Строка 19: Строка 19:
**[[GET все задания автообновления]]
**[[GET все задания автообновления]]
**[[GET конкретное задание автообновления]]
**[[GET конкретное задание автообновления]]
**[[Разместить задание автообновления]]
**[[POST задание автообновления]]
**[[Удалить задание автообновления]]
**[[DELETE задание автообновления]]
**[[Получение АктивныхШлюзов с автообновлением заданий]]
**[[GET АктивныхШлюзов с автообновлением заданий]]


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


* [[Выполнение задания анонимизации]]
*[[PUT задания анонимизации]]
* [[Получить статус анонимизации]]
*[[GET статус анонимизации]]


=== Безопасность приложения ===
=== Безопасность приложения ===
Строка 43: Строка 43:


* [[GET лога аудита]]
* [[GET лога аудита]]
* [[Получение записи лога аудита|Получить запись лога аудита]]
*[[GET запись лога аудита]]


=== Информация о кластере ===
=== Информация о кластере ===
[[Информация о кластере|Получить информацию о кластере]]
[[GET информацию о кластере]]


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


* [[Получение тегов|Получить теги]]
*[[GET теги]]
* [[POST-теги]]
* [[POST-теги]]
* [[Удаление тегов|Удалить теги]]
*[[DELETE тегов]]


=== Развёртывание ===
=== Развёртывание ===
Строка 65: Строка 65:


*
*
*[[События v1]]
*События v1
**[[Получение ленты событий]]
**[[GET ленты событий]]
**[[Получение события]]
**[[GET события]]
**[[Размещение события]]
**[[POST события]]
**[[Отправка событий развертывания из Jenkins]]
**[[Отправка событий развертывания из Jenkins]]
*События v2
*События v2
**[[Получение списка событий]]
**[[GET списка событий]]
**[[Получение события v2]]
**[[GET события v2]]
**[[Размещение события v2]]
**[[POST события v2]]
**[[Получение всех типов событий]]
**[[GET всех типов событий]]
**[[Получение типа события]]
**[[GET типа события]]
**[[Получение всех свойств события]]
**[[GET всех свойств события]]
**[[Получение свойства события]]
**[[GET свойства события]]
*Расширения 2.0
*Расширения 2.0
**Конфигурации среды
**Конфигурации среды
***[[Расширения 2.0 API - GET активация|GET конфигурации среды]]
***[[Расширения 2.0 API - GET активация|GET конфигурации среды]]
***[[Размещение конфигурации среды]]
***[[PUT конфигурации среды]]
***[[Реализация активации конфигурации]]
***[[POST активации конфигурации]]
***[[Деактивация конфигурации]]
***[[DELETE деактивация конфигурации]]
***[[Получение списка событий 2|Получение списка событий]]
***[[GET списка событий - Расширения 2.0|GET списка событий]]
**Расширения
**Расширения
***[[Получение всех расширений]]
***[[GET всех расширений - Расширения|GET всех расширений]]
***[[Получение версии расширения]]
***[[GET версии расширения]]
***[[Получение расширения]]
***[[GET расширения]]
***[[Размещение файла расширения]]
***[[POST файла расширения]]
***[[Удаление версии расширения]]
***[[DELETE версии расширения]]
***[[Получение схемы расширения]]
***[[GET схемы расширения]]
**Конфигурации мониторинга
**Конфигурации мониторинга
***[[Получение всех конфигураций мониторинга]]
***[[GET всех конфигураций мониторинга]]
***[[Получение конфигурации мониторинга]]
***[[GET конфигурации мониторинга]]
***[[Размещение конфигурации мониторинга]]
***[[POST конфигурации мониторинга]]
***[[Установка конфигурации мониторинга]]
***[[PUT конфигурации мониторинга]]
***[[Удаление конфигурации мониторинга]]
***[[DELETE конфигурации мониторинга]]
***[[Получение списка событий2|Получение списка событий]]
***[[GET списка событий - Конфигурации мониторинга|GET списка событий]]
***[[Получение статуса]]
***[[GET статуса]]
**Схемы
**Схемы
***[[Получение всех схем]]
***[[GET всех схем]]
***[[Получение всех файлов]]
***[[GET всех файлов]]
***[[Получение файла]]
***[[GET файла]]
*Мониторинг логов
*Мониторинг логов
**[[Получение лога поиска]]
**[[GET лога поиска]]
**[[Получение лога экспорта]]
**[[GET лога экспорта]]
**[[Получение сводного лога]]
**[[GET сводного лога]]
**[[Размещение лога загрузки]]
**[[POST лога нагрузки]]
*Таймсерии v1
*Таймсерии v1
**[[Пользовательские метрики]]
**[[Пользовательские метрики]]
***[[Создание пользовательской метрики]]
***[[PUT пользовательской метрики]]
***[[Удаление пользовательской метрики]]
***[[DELETE пользовательской метрики - Пользовательские метрики|DELETE пользовательской метрики]]
**Определение метрик
**Определение метрик
***[[Получение списка метрик]]
***[[GET списка метрик]]
***[[Получение определения метрик]]
***[[GET определения метрик]]
**Чтение точек данных
**Чтение точек данных
***[[GET точек данных]]
***[[GET точек данных]]
***[[Размещение точек данных]]
***[[POST точек данных]]


*Метрики v2
*Метрики v2
**[[Получение метрик]]
**[[GET метрик]]
**[[Получение дескриптора метрики]]
**[[Получение дескриптора метрики]]
**[[Получение точки данных метрики]]
**[[Получение точки данных метрики]]

Текущая версия на 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, где вы можете ввести дополнительные параметры и изменить полезную нагрузку запроса перед его выполнением, нажав кнопку «Выполнить» .