Получение статуса: различия между версиями
Материал из Документация Ключ-АСТРОМ
ENetrebin (обсуждение | вклад) |
ENetrebin (обсуждение | вклад) |
||
| Строка 8: | Строка 8: | ||
|- | |- | ||
|SaaS | |SaaS | ||
|<code><nowiki>https://{your-environment-id}.live. | |<code><nowiki>https://{your-environment-id}.live.ruscomtech.ru/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/status</nowiki></code> | ||
|- | |- | ||
|Окружающая среда АктивногоШлюза | |Окружающая среда АктивногоШлюза | ||
| Строка 47: | Строка 47: | ||
|- | |- | ||
|200 | |200 | ||
| | |StatusDto | ||
|Успех | |Успех | ||
|- | |- | ||
| Строка 57: | Строка 57: | ||
=== Объекты тела ответа === | === Объекты тела ответа === | ||
==== Объект | ==== Объект <code>ExtensionStatusDto</code> ==== | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
Текущая версия на 10:31, 7 октября 2022
Получает самое последнее выполнение конфигурации мониторинга.
Запрос создает application/jsonполезную нагрузку.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/status
|
| SaaS | https://{your-environment-id}.live.ruscomtech.ru/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/status
| |
| Окружающая среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/status
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение конфигураций мониторинга расширений ( extensionConfigurations.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимый |
|---|---|---|---|---|
| extensionName | string | Имя запрошенного расширения 2.0. | path | требуется |
| configurationId | string | Идентификатор запрошенной конфигурации мониторинга. | path | требуется |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | StatusDto | Успех |
| 404 | ErrorEnvelope | Не удалось. Запрошенный ресурс не существует. |
Объекты тела ответа
Объект ExtensionStatusDto
| Элемент | Тип | Описание |
|---|---|---|
| оtimestamp | integer | Временная метка последнего состояния данной конфигурации. |
| status | string | Последний статус данной конфигурации.
Элемент может содержать эти значения
|
JSON-модель тела ответа
{
"timestamp": 1,
"status": "ERROR"
}
