(Новая страница: «Этот вызов API извлекает состояние Лога Мониторинга для указанной среды. ==Аутентификаци...») |
Нет описания правки |
||
| (не показана 1 промежуточная версия этого же участника) | |||
| Строка 1: | Строка 1: | ||
'''''[[Установка и настройка]] / [[Установка и настройка|Основные элементы АппОптима]] / [[АппОптима]] / [[АппОптима|REST API]] / [[API Кластера v2]] / [[API Кластера v2|Лог мониторинга]] / Получение состояния Лога мониторинга''''' | |||
Этот вызов API извлекает состояние Лога Мониторинга для указанной среды. | Этот вызов API извлекает состояние Лога Мониторинга для указанной среды. | ||
==Аутентификация== | ==Аутентификация== | ||
Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. | Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера. | ||
==Конечная точка== | ==Конечная точка== | ||
<code>/api/cluster/v2/logMonitoring/{environmentId}/status</code> | <code>/api/cluster/v2/logMonitoring/{environmentId}/status</code> | ||
| Строка 49: | Строка 51: | ||
=== JSON-модель тела ответа === | === JSON-модель тела ответа === | ||
< | <{ | ||
"enabled": "true" | "enabled": "true" | ||
} | } | ||
==Пример== | ==Пример== | ||
| Строка 61: | Строка 63: | ||
==== Тело ответа ==== | ==== Тело ответа ==== | ||
< | <{ | ||
"enabled": "true" | "enabled": "true" | ||
} | } | ||
====Код ответа==== | ====Код ответа==== | ||
<code>200</code> | <code>200</code> | ||
Текущая версия от 07:37, 7 января 2025
Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v2 / Лог мониторинга / Получение состояния Лога мониторинга
Этот вызов API извлекает состояние Лога Мониторинга для указанной среды.
Аутентификация
Для выполнения этого запроса вам необходимо разрешение API (ServiceProviderAPI), назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
Конечная точка
/api/cluster/v2/logMonitoring/{environmentId}/status
Параметры
| Параметр | Тип | Описание | В | Обязательно |
|---|---|---|---|---|
| environmentId | string | Идентификатор среды. | path | Да |
Ответ
Коды ответа
| Код | Тип | |
|---|---|---|
| 200 | LogMonitoringStatus | Успешная операция. |
| 404 | Не удалось. Запрошенный ресурс не существует. |
Объекты тела ответа
Объект LogMonitoringStatus
| Элемент | Тип | Описание |
|---|---|---|
| enabled | boolean | Указывает, включен ли мониторинг журналов. |
JSON-модель тела ответа
<{
"enabled": "true"
}
Пример
В этом примере вы получаете состояние конфигурации Log Monitoring для среды: 19a963a7-b19f-4382-964a-4df674c8eb8e. В ответ вы получите ответ JSON, указывающий, что в этой среде включена последняя версия Log Monitoring.
Curl
curl -X GET "https://myManaged.cluster.com/api/cluster/v2/logMonitoring/19a963a7-b19f-4382-964a-4df674c8eb8e/status" -H "accept: application/json; charset=utf-8"
URL-адрес запроса
https://myManaged.cluster.com/api/cluster/v2/logMonitoring/19a963a7-b19f-4382-964a-4df674c8eb8e/status
Тело ответа
<{
"enabled": "true"
}
Код ответа
200